| com.flexive.shared.interfaces.AssignmentEngine
All known Subclasses: com.flexive.ejb.beans.structure.AssignmentEngineBean,
| AssignmentEngine | | public interface AssignmentEngine (Code) | | Structure Assignment management
author:
Markus Plesser (markus.plesser@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at) |
| Method Summary | |
| long | createGroup(FxGroupEdit group, String parentXPath)
| | long | createGroup(long typeId, FxGroupEdit group, String parentXPath)
| | long | createProperty(FxPropertyEdit property, String parentXPath)
| | long | createProperty(long typeId, FxPropertyEdit property, String parentXPath)
| | long | createProperty(long typeId, FxPropertyEdit property, String parentXPath, String assignmentAlias)
Create a new property and assign it at the given parentXPath to the given type using assignmentAlias instead of
properties name. | | long | getAssignmentInstanceCount(long assignmentId)
| | long | getPropertyInstanceCount(long propertyId)
Get the number of existing content instances using a given property. | | void | removeAssignment(long assignmentId, boolean removeSubAssignments, boolean removeDerivedAssignments)
| | long | save(FxAssignment assignment, boolean createSubAssignments)
Save an existing or create a new assignment. | | long | save(FxPropertyEdit property)
Save an existing property. | | long | save(FxGroupEdit group)
Save an existing group. |
| createProperty | | long createProperty(long typeId, FxPropertyEdit property, String parentXPath, String assignmentAlias) throws FxApplicationException(Code) | | Create a new property and assign it at the given parentXPath to the given type using assignmentAlias instead of
properties name.
Parameters:
typeId - id of the type to assign this property to
Parameters:
property - property to create
Parameters:
parentXPath - the property's parent xpath
Parameters:
assignmentAlias - alias to use for the assignment to the type assignment id of the property
throws:
FxApplicationException - on errors
throws:
FxInvalidParameterException - if the given parentXPath is not valid
throws:
FxEntryExistsException - if a property with this name already exists at the requested parentXPath
throws:
FxNoAccessException - if the calling user is not permitted to call this method |
| getPropertyInstanceCount | | long getPropertyInstanceCount(long propertyId) throws FxDbException(Code) | | Get the number of existing content instances using a given property.
Parameters:
propertyId - id of the requested assignment number of content instances using the assignment
throws:
com.flexive.shared.exceptions.FxDbException - on errors |
| removeAssignment | | void removeAssignment(long assignmentId, boolean removeSubAssignments, boolean removeDerivedAssignments) throws FxApplicationException(Code) | | Remove an assignment
Parameters:
assignmentId - assignment to remove
Parameters:
removeSubAssignments - if assignment is a group, remove all attached properties and groups?
Parameters:
removeDerivedAssignments - if derivates of this assignment in derived types exist, remove them as well?
throws:
FxApplicationException - on errors
throws:
FxNotFoundException - if the assignmentId is invalid
throws:
FxRemoveException - on remove errors
throws:
FxNoAccessException - if the calling user is not permitted to call this method |
|
|