Package org.alfresco.rest.api.impl
Class CustomModelsImpl
java.lang.Object
org.alfresco.rest.api.impl.CustomModelsImpl
- All Implemented Interfaces:
CustomModels
- Author:
- Jamal Kaabi-Mofrad
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
Constraint validatorclass
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
protected org.alfresco.service.cmr.dictionary.CustomModelService
protected org.alfresco.service.cmr.dictionary.DictionaryService
static final String
static final Pattern
protected org.alfresco.service.namespace.NamespaceService
protected NodeService
protected PersonService
static final String
static final Pattern
protected ValueDataTypeValidator
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateCustomAspect
(String modelName, CustomAspect aspect) Creates custom model's aspectcreateCustomModel
(M2Model m2Model) Creates custom model from the importedM2Model
.createCustomModel
(CustomModel model) Creates custom modelcreateCustomModelConstraint
(String modelName, CustomModelConstraint constraint) Creates custom model's constraintcreateCustomType
(String modelName, CustomType type) Creates custom model's typecreateDownload
(String modelName, Parameters parameters) Starts the creation of a downloadable archive file containing the custom model file and its associated Share extension module file (if requested).void
deleteCustomAspect
(String modelName, String aspectName) Deletes the custom model's aspectvoid
deleteCustomModel
(String modelName) Deletes the custom modelvoid
deleteCustomType
(String modelName, String typeName) Deletes the custom model's typeprotected String
Gets the fully authenticated user's full namegetCustomAspect
(String modelName, String aspectName, Parameters parameters) Gets theorg.alfresco.rest.api.model.CustomAspect
representation of the given model's aspectgetCustomAspects
(String modelName, Parameters parameters) Gets a paged list of all the given custom model's aspectsgetCustomModel
(String modelName, Parameters parameters) Gets theorg.alfresco.rest.api.model.CustomModel
representation for the given modelgetCustomModelConstraint
(String modelName, String constraintName, Parameters parameters) Gets theorg.alfresco.rest.api.model.CustomModelConstraint
representation of the given model's constraintgetCustomModelConstraints
(String modelName, Parameters parameters) Gets a paged list of all of the given custom model's constraintsgetCustomModels
(Parameters parameters) Gets a paged list of all custom modelsgetCustomType
(String modelName, String typeName, Parameters parameters) Gets theorg.alfresco.rest.api.model.CustomType
representation of the given model's typegetCustomTypes
(String modelName, Parameters parameters) Gets a paged list of all the given custom model's typesresolveToUriAndPrefix
(String parentName) Gets the namespace URI and prefix from the parent's name, provided that the given name is of a valid format.void
setCustomModelService
(org.alfresco.service.cmr.dictionary.CustomModelService customModelService) void
setDictionaryService
(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService) void
setNamespaceService
(org.alfresco.service.namespace.NamespaceService namespaceService) void
setNodeService
(NodeService nodeService) void
setPersonService
(PersonService personService) void
setValueDataTypeValidator
(ValueDataTypeValidator valueDataTypeValidator) updateCustomAspect
(String modelName, CustomAspect aspect, Parameters parameters) Updates the custom model's aspectupdateCustomModel
(String modelName, CustomModel model, Parameters parameters) Updates or activates/deactivates the custom modelupdateCustomType
(String modelName, CustomType type, Parameters parameters) Updates the custom model's type
-
Field Details
-
NAME_PATTERN
-
URI_PATTERN
-
MODEL_NAME_NULL_ERR
- See Also:
-
TYPE_NAME_NULL_ERR
- See Also:
-
ASPECT_NAME_NULL_ERR
- See Also:
-
CONSTRAINT_NAME_NULL_ERR
- See Also:
-
customModelService
protected org.alfresco.service.cmr.dictionary.CustomModelService customModelService -
dictionaryService
protected org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService -
personService
-
nodeService
-
namespaceService
protected org.alfresco.service.namespace.NamespaceService namespaceService -
valueDataTypeValidator
-
-
Constructor Details
-
CustomModelsImpl
public CustomModelsImpl()
-
-
Method Details
-
setCustomModelService
public void setCustomModelService(org.alfresco.service.cmr.dictionary.CustomModelService customModelService) -
setDictionaryService
public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService) -
setPersonService
-
setNodeService
-
setNamespaceService
public void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService) -
setValueDataTypeValidator
-
getCustomModel
Description copied from interface:CustomModels
Gets theorg.alfresco.rest.api.model.CustomModel
representation for the given model- Specified by:
getCustomModel
in interfaceCustomModels
- Parameters:
modelName
- the model nameparameters
- theParameters
object to get the parameters passed into the request- Returns:
org.alfresco.rest.api.model.CustomModel
object
-
getCustomModels
Description copied from interface:CustomModels
Gets a paged list of all custom models- Specified by:
getCustomModels
in interfaceCustomModels
- Parameters:
parameters
- theParameters
object to get the parameters passed into the request- Returns:
- a paged list of
org.alfresco.rest.api.model.CustomModel
objects
-
createCustomModel
Description copied from interface:CustomModels
Creates custom model- Specified by:
createCustomModel
in interfaceCustomModels
- Parameters:
model
- the custom model to create- Returns:
org.alfresco.rest.api.model.CustomModel
object
-
updateCustomModel
Description copied from interface:CustomModels
Updates or activates/deactivates the custom model- Specified by:
updateCustomModel
in interfaceCustomModels
- Parameters:
modelName
- the model namemodel
- the custom model to update (JSON payload)parameters
- theParameters
object to get the parameters passed into the request- Returns:
org.alfresco.rest.api.model.CustomModel
object
-
deleteCustomModel
Description copied from interface:CustomModels
Deletes the custom model- Specified by:
deleteCustomModel
in interfaceCustomModels
- Parameters:
modelName
- the model name
-
getCustomType
Description copied from interface:CustomModels
Gets theorg.alfresco.rest.api.model.CustomType
representation of the given model's type- Specified by:
getCustomType
in interfaceCustomModels
- Parameters:
modelName
- the model nametypeName
- the model's type nameparameters
- theParameters
object to get the parameters passed into the request- Returns:
org.alfresco.rest.api.model.CustomType
object
-
getCustomTypes
Description copied from interface:CustomModels
Gets a paged list of all the given custom model's types- Specified by:
getCustomTypes
in interfaceCustomModels
- Parameters:
modelName
- the model nameparameters
- theParameters
object to get the parameters passed into the request- Returns:
- a paged list of
org.alfresco.rest.api.model.CustomType
objects
-
createCustomType
Description copied from interface:CustomModels
Creates custom model's type- Specified by:
createCustomType
in interfaceCustomModels
- Parameters:
modelName
- the model nametype
- the custom type to create within the given model- Returns:
org.alfresco.rest.api.model.CustomType
object
-
updateCustomType
Description copied from interface:CustomModels
Updates the custom model's type- Specified by:
updateCustomType
in interfaceCustomModels
- Parameters:
modelName
- the model nametype
- the custom model's type to update (JSON payload)parameters
- theParameters
object to get the parameters passed into the request- Returns:
org.alfresco.rest.api.model.CustomType
object
-
deleteCustomType
Description copied from interface:CustomModels
Deletes the custom model's type- Specified by:
deleteCustomType
in interfaceCustomModels
- Parameters:
modelName
- the model nametypeName
- the model's type name
-
getCustomAspect
Description copied from interface:CustomModels
Gets theorg.alfresco.rest.api.model.CustomAspect
representation of the given model's aspect- Specified by:
getCustomAspect
in interfaceCustomModels
- Parameters:
modelName
- the model nameaspectName
- the model's aspect nameparameters
- theParameters
object to get the parameters passed into the request- Returns:
org.alfresco.rest.api.model.CustomAspect
object
-
getCustomAspects
public CollectionWithPagingInfo<CustomAspect> getCustomAspects(String modelName, Parameters parameters) Description copied from interface:CustomModels
Gets a paged list of all the given custom model's aspects- Specified by:
getCustomAspects
in interfaceCustomModels
- Parameters:
modelName
- the model nameparameters
- theParameters
object to get the parameters passed into the request- Returns:
- a paged list of
org.alfresco.rest.api.model.CustomAspect
objects
-
createCustomAspect
Description copied from interface:CustomModels
Creates custom model's aspect- Specified by:
createCustomAspect
in interfaceCustomModels
- Parameters:
modelName
- the model nameaspect
- the custom aspect to create within the given model- Returns:
org.alfresco.rest.api.model.CustomAspect
object
-
updateCustomAspect
public CustomAspect updateCustomAspect(String modelName, CustomAspect aspect, Parameters parameters) Description copied from interface:CustomModels
Updates the custom model's aspect- Specified by:
updateCustomAspect
in interfaceCustomModels
- Parameters:
modelName
- the model nameaspect
- the custom model's aspect to update (JSON payload)parameters
- theParameters
object to get the parameters passed into the request- Returns:
org.alfresco.rest.api.model.CustomAspect
object
-
deleteCustomAspect
Description copied from interface:CustomModels
Deletes the custom model's aspect- Specified by:
deleteCustomAspect
in interfaceCustomModels
- Parameters:
modelName
- the model nameaspectName
- the model's aspect name
-
getCustomModelConstraints
public CollectionWithPagingInfo<CustomModelConstraint> getCustomModelConstraints(String modelName, Parameters parameters) Description copied from interface:CustomModels
Gets a paged list of all of the given custom model's constraints- Specified by:
getCustomModelConstraints
in interfaceCustomModels
- Parameters:
modelName
- the model nameparameters
- theParameters
object to get the parameters passed into the request- Returns:
- a paged list of
org.alfresco.rest.api.model.CustomModelConstraint
objects
-
getCustomModelConstraint
public CustomModelConstraint getCustomModelConstraint(String modelName, String constraintName, Parameters parameters) Description copied from interface:CustomModels
Gets theorg.alfresco.rest.api.model.CustomModelConstraint
representation of the given model's constraint- Specified by:
getCustomModelConstraint
in interfaceCustomModels
- Parameters:
modelName
- the model nameconstraintName
- the model's constraint nameparameters
- theParameters
object to get the parameters passed into the request- Returns:
org.alfresco.rest.api.model.CustomModelConstraint
object
-
createCustomModelConstraint
public CustomModelConstraint createCustomModelConstraint(String modelName, CustomModelConstraint constraint) Description copied from interface:CustomModels
Creates custom model's constraint- Specified by:
createCustomModelConstraint
in interfaceCustomModels
- Parameters:
modelName
- the model nameconstraint
- the custom constraint to create within the given model- Returns:
org.alfresco.rest.api.model.CustomModelConstraint
object
-
createDownload
Description copied from interface:CustomModels
Starts the creation of a downloadable archive file containing the custom model file and its associated Share extension module file (if requested).- Specified by:
createDownload
in interfaceCustomModels
- Parameters:
modelName
- the model nameparameters
- theParameters
object to get the parameters passed into the request- Returns:
org.alfresco.rest.api.model.CustomModelDownload
object containing the archive node reference
-
getCurrentUserFullName
Gets the fully authenticated user's full name- Returns:
- user's full name or the user's id if the full name dose not exit
-
resolveToUriAndPrefix
Gets the namespace URI and prefix from the parent's name, provided that the given name is of a valid format. The valid format consist of a namespace prefix, a colon and a name. E.g. sys:localized- Parameters:
parentName
- the parent name- Returns:
- a pair of namespace URI and prefix object
-
createCustomModel
Description copied from interface:CustomModels
Creates custom model from the importedM2Model
.- Specified by:
createCustomModel
in interfaceCustomModels
- Parameters:
m2Model
- the model- Returns:
org.alfresco.rest.api.model.CustomModel
object
-