Package org.alfresco.rest.api
Interface CustomModels
- All Known Implementing Classes:
CustomModelsImpl
public interface CustomModels
- Author:
- Jamal Kaabi-Mofrad
-
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 typegetCustomAspect
(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 typesupdateCustomAspect
(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
-
Method Details
-
getCustomModel
Gets theorg.alfresco.rest.api.model.CustomModel
representation for the given model- Parameters:
modelName
- the model nameparameters
- theParameters
object to get the parameters passed into the request- Returns:
org.alfresco.rest.api.model.CustomModel
object
-
getCustomModels
Gets a paged list of all custom models- 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
Creates custom model- Parameters:
model
- the custom model to create- Returns:
org.alfresco.rest.api.model.CustomModel
object
-
createCustomModel
Creates custom model from the importedM2Model
.- Parameters:
m2Model
- the model- Returns:
org.alfresco.rest.api.model.CustomModel
object
-
updateCustomModel
Updates or activates/deactivates the custom model- 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
Deletes the custom model- Parameters:
modelName
- the model name
-
getCustomType
Gets theorg.alfresco.rest.api.model.CustomType
representation of the given model's type- 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
Gets a paged list of all the given custom model's types- 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
Creates custom model's type- Parameters:
modelName
- the model nametype
- the custom type to create within the given model- Returns:
org.alfresco.rest.api.model.CustomType
object
-
updateCustomType
Updates the custom model's type- 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
Deletes the custom model's type- Parameters:
modelName
- the model nametypeName
- the model's type name
-
getCustomAspect
Gets theorg.alfresco.rest.api.model.CustomAspect
representation of the given model's aspect- 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
Gets a paged list of all the given custom model's aspects- 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
Creates custom model's aspect- Parameters:
modelName
- the model nameaspect
- the custom aspect to create within the given model- Returns:
org.alfresco.rest.api.model.CustomAspect
object
-
updateCustomAspect
Updates the custom model's aspect- 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
Deletes the custom model's aspect- Parameters:
modelName
- the model nameaspectName
- the model's aspect name
-
getCustomModelConstraint
CustomModelConstraint getCustomModelConstraint(String modelName, String constraintName, Parameters parameters) Gets theorg.alfresco.rest.api.model.CustomModelConstraint
representation of the given model's constraint- 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
-
getCustomModelConstraints
CollectionWithPagingInfo<CustomModelConstraint> getCustomModelConstraints(String modelName, Parameters parameters) Gets a paged list of all of the given custom model's constraints- 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
-
createCustomModelConstraint
CustomModelConstraint createCustomModelConstraint(String modelName, CustomModelConstraint constraint) Creates custom model's constraint- Parameters:
modelName
- the model nameconstraint
- the custom constraint to create within the given model- Returns:
org.alfresco.rest.api.model.CustomModelConstraint
object
-
createDownload
Starts the creation of a downloadable archive file containing the custom model file and its associated Share extension module file (if requested).- 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
-