|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Allows querying and manipulation of the Repository Schema.
The Repository Schema defines the types of documents that can be stored
in the repository. See DocumentType
for more information about what
constitutes a Document Type.
The various get methods all take a parameter "updateable". If true, the returned object can be modified and saved, and is caller-specific. If false, the returned object is not updateable (thus immutable), and the same object instance can be returned to different callers (i.e. it is threadsafe). The returned objects can in that case be retrieved from a cache, allowing very fast access to the schema information. So in general, if you don't need to modify the schema information, supply false for the updateable parameter.
Method Summary | |
void |
addListener(RepositorySchemaListener listener)
|
DocumentType |
createDocumentType(java.lang.String name)
Creates a new document type with the given name. |
FieldType |
createFieldType(java.lang.String name,
ValueType valueType)
|
FieldType |
createFieldType(java.lang.String name,
ValueType valueType,
boolean multiValue)
|
DocumentType |
createNewDocumentType(java.lang.String name)
Deprecated. Use createDocumentType instead. |
FieldType |
createNewFieldType(java.lang.String name,
ValueType valueType)
Deprecated. Use createFieldType instead. |
PartType |
createNewPartType(java.lang.String name,
java.lang.String mimeTypes)
Deprecated. Use createPartType instead. |
PartType |
createPartType(java.lang.String name,
java.lang.String mimeTypes)
|
void |
deleteDocumentType(long documentTypeId)
|
void |
deleteFieldType(long fieldTypeId)
|
void |
deletePartType(long partTypeId)
|
DocumentTypes |
getAllDocumentTypes(boolean updateable)
|
FieldTypes |
getAllFieldTypes(boolean updateable)
|
PartTypes |
getAllPartTypes(boolean updateable)
|
DocumentType |
getDocumentTypeById(long id,
boolean updateable)
|
DocumentType |
getDocumentTypeByName(java.lang.String name,
boolean updateable)
|
FieldType |
getFieldTypeById(long id,
boolean updateable)
|
FieldType |
getFieldTypeByName(java.lang.String name,
boolean updateable)
|
PartType |
getPartTypeById(long id,
boolean updateable)
|
PartType |
getPartTypeByName(java.lang.String name,
boolean updateable)
|
void |
removeListener(RepositorySchemaListener listener)
|
Method Detail |
public DocumentType createNewDocumentType(java.lang.String name)
public DocumentType createDocumentType(java.lang.String name)
public void deleteDocumentType(long documentTypeId) throws RepositoryException
RepositoryException
public FieldType createNewFieldType(java.lang.String name, ValueType valueType)
public FieldType createFieldType(java.lang.String name, ValueType valueType)
public FieldType createFieldType(java.lang.String name, ValueType valueType, boolean multiValue)
public void deleteFieldType(long fieldTypeId) throws RepositoryException
RepositoryException
public PartType createNewPartType(java.lang.String name, java.lang.String mimeTypes)
public PartType createPartType(java.lang.String name, java.lang.String mimeTypes)
public void deletePartType(long partTypeId) throws RepositoryException
RepositoryException
public void addListener(RepositorySchemaListener listener)
public void removeListener(RepositorySchemaListener listener)
public DocumentTypes getAllDocumentTypes(boolean updateable) throws RepositoryException
RepositoryException
public FieldTypes getAllFieldTypes(boolean updateable) throws RepositoryException
RepositoryException
public PartTypes getAllPartTypes(boolean updateable) throws RepositoryException
RepositoryException
public PartType getPartTypeById(long id, boolean updateable) throws RepositoryException
PartTypeNotFoundException
- in case the part type does not exist.
RepositoryException
public PartType getPartTypeByName(java.lang.String name, boolean updateable) throws RepositoryException
PartTypeNotFoundException
- in case the part type does not exist.
RepositoryException
public FieldType getFieldTypeById(long id, boolean updateable) throws RepositoryException
FieldTypeNotFoundException
- in case the field type does not exist.
RepositoryException
public FieldType getFieldTypeByName(java.lang.String name, boolean updateable) throws RepositoryException
FieldTypeNotFoundException
- in case the field type does not exist.
RepositoryException
public DocumentType getDocumentTypeById(long id, boolean updateable) throws RepositoryException
DocumentTypeNotFoundException
- in case the document type does not exist.
RepositoryException
public DocumentType getDocumentTypeByName(java.lang.String name, boolean updateable) throws RepositoryException
DocumentTypeNotFoundException
- in case the document type does not exist.
RepositoryException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |