org.outerj.daisy.repository.commonimpl
Class DocumentVariantImpl
java.lang.Object
org.outerj.daisy.repository.commonimpl.DocumentVariantImpl
public class DocumentVariantImpl
- extends java.lang.Object
Encapsulates all variant-specific data of a document.
An instance of this class is contained by DocumentImpl
.
Method Summary |
void |
addLink(java.lang.String title,
java.lang.String target)
|
void |
addNonVersionedDataToXml(org.outerx.daisy.x10.DocumentDocument.Document documentXml)
|
void |
addToCollection(org.outerj.daisy.repository.DocumentCollection c)
|
void |
addXml(org.outerx.daisy.x10.DocumentDocument.Document documentXml)
|
void |
addXml(org.outerx.daisy.x10.DocumentDocument.Document documentXml,
long versionId)
|
void |
changeDocumentType(long documentTypeId)
|
void |
changeDocumentType(java.lang.String documentTypeName)
|
void |
clearCollections()
|
void |
clearCustomFields()
|
void |
clearLinks()
|
void |
clearLockInfo()
|
void |
deleteCustomField(java.lang.String name)
|
void |
deleteField(long fieldTypeId)
|
void |
deleteField(java.lang.String name)
|
void |
deleteLink(int index)
|
void |
deletePart(long partTypeId)
|
void |
deletePart(java.lang.String name)
|
long |
getBranchId()
|
org.outerj.daisy.repository.DocumentCollections |
getCollections()
|
long |
getCreatedFromBranchId()
|
long |
getCreatedFromLanguageId()
|
long |
getCreatedFromVersionId()
|
java.lang.String |
getCustomField(java.lang.String name)
|
java.util.Map |
getCustomFields()
|
long |
getDocumentId()
|
long |
getDocumentTypeId()
|
org.outerj.daisy.repository.Field |
getField(long fieldTypeId)
|
org.outerj.daisy.repository.Field |
getField(java.lang.String name)
|
org.outerj.daisy.repository.Fields |
getFields()
|
org.outerj.daisy.repository.Fields |
getFieldsInOrder()
|
DocumentVariantImpl.IntimateAccess |
getIntimateAccess(DocumentStrategy strategy)
|
long |
getLanguageId()
|
java.util.Date |
getLastModified()
|
long |
getLastModifier()
|
org.outerj.daisy.repository.Version |
getLastVersion()
|
long |
getLastVersionId()
|
org.outerj.daisy.repository.Links |
getLinks()
|
org.outerj.daisy.repository.Version |
getLiveVersion()
|
long |
getLiveVersionId()
|
org.outerj.daisy.repository.LockInfo |
getLockInfo(boolean fresh)
|
java.lang.String |
getName()
|
org.outerj.daisy.repository.VersionState |
getNewVersionState()
|
org.outerj.daisy.repository.Part |
getPart(long partTypeId)
|
org.outerj.daisy.repository.Part |
getPart(java.lang.String name)
|
org.outerj.daisy.repository.Parts |
getParts()
|
org.outerj.daisy.repository.Parts |
getPartsInOrder()
|
java.lang.String |
getSummary()
|
long |
getUpdateCount()
|
org.outerj.daisy.repository.Version |
getVersion(long versionId)
|
org.outerj.daisy.repository.Versions |
getVersions()
|
boolean |
hasCustomField(java.lang.String name)
|
boolean |
hasField(long fieldTypeId)
|
boolean |
hasField(java.lang.String fieldTypeName)
|
boolean |
hasPart(long partTypeId)
|
boolean |
hasPart(java.lang.String name)
|
boolean |
inCollection(org.outerj.daisy.repository.DocumentCollection collection)
|
boolean |
inCollection(long collectionId)
|
boolean |
isNew()
|
boolean |
isRetired()
|
boolean |
lock(long duration,
org.outerj.daisy.repository.LockType lockType)
|
boolean |
needsNewVersion()
Checks whether this document needs a new version. |
boolean |
needsSaving()
|
boolean |
releaseLock()
|
void |
removeFromCollection(org.outerj.daisy.repository.DocumentCollection c)
|
void |
setCustomField(java.lang.String name,
java.lang.String value)
|
void |
setField(long fieldTypeId,
java.lang.Object value)
|
void |
setField(java.lang.String name,
java.lang.Object value)
|
void |
setName(java.lang.String name)
|
void |
setNewVersionState(org.outerj.daisy.repository.VersionState versionState)
|
void |
setPart(long partTypeId,
java.lang.String mimeType,
byte[] data)
|
void |
setPart(long partTypeId,
java.lang.String mimeType,
org.outerj.daisy.repository.PartDataSource partDataSource)
|
void |
setPart(java.lang.String partTypeName,
java.lang.String mimeType,
byte[] data)
|
void |
setPart(java.lang.String partTypeName,
java.lang.String mimeType,
org.outerj.daisy.repository.PartDataSource partDataSource)
|
void |
setPartFileName(long partTypeId,
java.lang.String fileName)
|
void |
setPartFileName(java.lang.String partTypeName,
java.lang.String fileName)
|
void |
setPartMimeType(long partTypeId,
java.lang.String mimeType)
|
void |
setPartMimeType(java.lang.String partTypeName,
java.lang.String mimeType)
|
void |
setRetired(boolean retired)
|
void |
setValidateOnSave(boolean validateOnSave)
|
void |
validate()
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
ERROR_ACCESSING_REPOSITORY_SCHEMA
public static final java.lang.String ERROR_ACCESSING_REPOSITORY_SCHEMA
- See Also:
- Constant Field Values
DocumentVariantImpl
public DocumentVariantImpl(DocumentImpl ownerDocument,
DocumentStrategy documentStrategy,
CommonRepositorySchema repositorySchema,
AuthenticatedUser currentUser,
long documentTypeId,
long branchId,
long languageId)
getIntimateAccess
public DocumentVariantImpl.IntimateAccess getIntimateAccess(DocumentStrategy strategy)
getBranchId
public long getBranchId()
getLanguageId
public long getLanguageId()
isNew
public boolean isNew()
getDocumentTypeId
public long getDocumentTypeId()
getDocumentId
public long getDocumentId()
setValidateOnSave
public void setValidateOnSave(boolean validateOnSave)
changeDocumentType
public void changeDocumentType(long documentTypeId)
throws org.outerj.daisy.repository.RepositoryException
- Throws:
org.outerj.daisy.repository.RepositoryException
changeDocumentType
public void changeDocumentType(java.lang.String documentTypeName)
throws org.outerj.daisy.repository.RepositoryException
- Throws:
org.outerj.daisy.repository.RepositoryException
getField
public org.outerj.daisy.repository.Field getField(java.lang.String name)
throws org.outerj.daisy.repository.FieldNotFoundException
- Throws:
org.outerj.daisy.repository.FieldNotFoundException
getField
public org.outerj.daisy.repository.Field getField(long fieldTypeId)
throws org.outerj.daisy.repository.FieldNotFoundException
- Throws:
org.outerj.daisy.repository.FieldNotFoundException
hasField
public boolean hasField(long fieldTypeId)
hasField
public boolean hasField(java.lang.String fieldTypeName)
getFields
public org.outerj.daisy.repository.Fields getFields()
getFieldsInOrder
public org.outerj.daisy.repository.Fields getFieldsInOrder()
setField
public void setField(java.lang.String name,
java.lang.Object value)
throws org.outerj.daisy.repository.DocumentTypeInconsistencyException
- Throws:
org.outerj.daisy.repository.DocumentTypeInconsistencyException
setField
public void setField(long fieldTypeId,
java.lang.Object value)
throws org.outerj.daisy.repository.DocumentTypeInconsistencyException
- Throws:
org.outerj.daisy.repository.DocumentTypeInconsistencyException
deleteField
public void deleteField(java.lang.String name)
deleteField
public void deleteField(long fieldTypeId)
getLockInfo
public org.outerj.daisy.repository.LockInfo getLockInfo(boolean fresh)
throws org.outerj.daisy.repository.RepositoryException
- Throws:
org.outerj.daisy.repository.RepositoryException
clearLockInfo
public void clearLockInfo()
lock
public boolean lock(long duration,
org.outerj.daisy.repository.LockType lockType)
throws org.outerj.daisy.repository.RepositoryException
- Throws:
org.outerj.daisy.repository.RepositoryException
releaseLock
public boolean releaseLock()
throws org.outerj.daisy.repository.RepositoryException
- Throws:
org.outerj.daisy.repository.RepositoryException
addXml
public void addXml(org.outerx.daisy.x10.DocumentDocument.Document documentXml)
throws org.outerj.daisy.repository.RepositoryException
- Throws:
org.outerj.daisy.repository.RepositoryException
addXml
public void addXml(org.outerx.daisy.x10.DocumentDocument.Document documentXml,
long versionId)
throws org.outerj.daisy.repository.RepositoryException
- Throws:
org.outerj.daisy.repository.RepositoryException
addNonVersionedDataToXml
public void addNonVersionedDataToXml(org.outerx.daisy.x10.DocumentDocument.Document documentXml)
setName
public void setName(java.lang.String name)
getName
public java.lang.String getName()
setPart
public void setPart(java.lang.String partTypeName,
java.lang.String mimeType,
byte[] data)
throws org.outerj.daisy.repository.DocumentTypeInconsistencyException
- Throws:
org.outerj.daisy.repository.DocumentTypeInconsistencyException
setPart
public void setPart(long partTypeId,
java.lang.String mimeType,
byte[] data)
throws org.outerj.daisy.repository.DocumentTypeInconsistencyException
- Throws:
org.outerj.daisy.repository.DocumentTypeInconsistencyException
setPart
public void setPart(java.lang.String partTypeName,
java.lang.String mimeType,
org.outerj.daisy.repository.PartDataSource partDataSource)
throws org.outerj.daisy.repository.DocumentTypeInconsistencyException
- Throws:
org.outerj.daisy.repository.DocumentTypeInconsistencyException
setPart
public void setPart(long partTypeId,
java.lang.String mimeType,
org.outerj.daisy.repository.PartDataSource partDataSource)
throws org.outerj.daisy.repository.DocumentTypeInconsistencyException
- Throws:
org.outerj.daisy.repository.DocumentTypeInconsistencyException
setPartFileName
public void setPartFileName(java.lang.String partTypeName,
java.lang.String fileName)
setPartFileName
public void setPartFileName(long partTypeId,
java.lang.String fileName)
setPartMimeType
public void setPartMimeType(java.lang.String partTypeName,
java.lang.String mimeType)
setPartMimeType
public void setPartMimeType(long partTypeId,
java.lang.String mimeType)
getParts
public org.outerj.daisy.repository.Parts getParts()
getPartsInOrder
public org.outerj.daisy.repository.Parts getPartsInOrder()
deletePart
public void deletePart(long partTypeId)
deletePart
public void deletePart(java.lang.String name)
getPart
public org.outerj.daisy.repository.Part getPart(long partTypeId)
throws org.outerj.daisy.repository.PartNotFoundException
- Throws:
org.outerj.daisy.repository.PartNotFoundException
getPart
public org.outerj.daisy.repository.Part getPart(java.lang.String name)
throws org.outerj.daisy.repository.PartNotFoundException
- Throws:
org.outerj.daisy.repository.PartNotFoundException
hasPart
public boolean hasPart(long partTypeId)
hasPart
public boolean hasPart(java.lang.String name)
setCustomField
public void setCustomField(java.lang.String name,
java.lang.String value)
deleteCustomField
public void deleteCustomField(java.lang.String name)
clearCustomFields
public void clearCustomFields()
clearCollections
public void clearCollections()
getCustomFields
public java.util.Map getCustomFields()
getCustomField
public java.lang.String getCustomField(java.lang.String name)
hasCustomField
public boolean hasCustomField(java.lang.String name)
getLinks
public org.outerj.daisy.repository.Links getLinks()
addLink
public void addLink(java.lang.String title,
java.lang.String target)
deleteLink
public void deleteLink(int index)
clearLinks
public void clearLinks()
validate
public void validate()
throws org.outerj.daisy.repository.DocumentTypeInconsistencyException
- Throws:
org.outerj.daisy.repository.DocumentTypeInconsistencyException
setNewVersionState
public void setNewVersionState(org.outerj.daisy.repository.VersionState versionState)
getNewVersionState
public org.outerj.daisy.repository.VersionState getNewVersionState()
getVersion
public org.outerj.daisy.repository.Version getVersion(long versionId)
throws org.outerj.daisy.repository.RepositoryException
- Throws:
org.outerj.daisy.repository.RepositoryException
getLastVersion
public org.outerj.daisy.repository.Version getLastVersion()
throws org.outerj.daisy.repository.RepositoryException
- Throws:
org.outerj.daisy.repository.RepositoryException
getLiveVersion
public org.outerj.daisy.repository.Version getLiveVersion()
throws org.outerj.daisy.repository.RepositoryException
- Throws:
org.outerj.daisy.repository.RepositoryException
getLiveVersionId
public long getLiveVersionId()
getVersions
public org.outerj.daisy.repository.Versions getVersions()
throws org.outerj.daisy.repository.RepositoryException
- Throws:
org.outerj.daisy.repository.RepositoryException
getLastVersionId
public long getLastVersionId()
getLastModified
public java.util.Date getLastModified()
getLastModifier
public long getLastModifier()
isRetired
public boolean isRetired()
setRetired
public void setRetired(boolean retired)
getCollections
public org.outerj.daisy.repository.DocumentCollections getCollections()
inCollection
public boolean inCollection(org.outerj.daisy.repository.DocumentCollection collection)
inCollection
public boolean inCollection(long collectionId)
addToCollection
public void addToCollection(org.outerj.daisy.repository.DocumentCollection c)
removeFromCollection
public void removeFromCollection(org.outerj.daisy.repository.DocumentCollection c)
getSummary
public java.lang.String getSummary()
getUpdateCount
public long getUpdateCount()
getCreatedFromBranchId
public long getCreatedFromBranchId()
getCreatedFromLanguageId
public long getCreatedFromLanguageId()
getCreatedFromVersionId
public long getCreatedFromVersionId()
needsNewVersion
public boolean needsNewVersion()
- Checks whether this document needs a new version. This is the case when:
needsSaving
public boolean needsSaving()
Copyright © -2012 . All Rights Reserved.