| com.flexive.shared.structure.FxEnvironment
All known Subclasses: com.flexive.shared.structure.FxFilteredEnvironment, com.flexive.core.structure.FxEnvironmentImpl,
| FxEnvironment | | public interface FxEnvironment extends Serializable(Code) | | Runtime object for structure metadata held in the cache
author:
Markus Plesser (markus.plesser@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at) |
| Method Summary | |
| ACL | getACL(long id)
| | ACL | getACL(String name)
| | List<ACL> | getACLs()
| | List<ACL> | getACLs(ACL.Category category)
Return all ACLs of the given category. | | List<ACL> | getACLs(long mandatorId)
Return all ACLs of a given mandatorId. | | List<ACL> | getACLs(long mandatorId, boolean includeForeignAccessible)
Return all ACLs of a given mandatorId and category.
Parameters:
mandatorId - the function loads all ACLs from this mandatorId.
Parameters:
includeForeignAccessible - when true, also loads ACLs that the calling user has at least one permission on,even if they belong to another mandator. | | List<ACL> | getACLs(long mandatorId, ACL.Category category, boolean includeForeignAccessible)
Return all ACLs of a given mandatorId and category.
Parameters:
mandatorId - the function loads all ACLs from this mandatorId.
Parameters:
category - a ACL.CATEGORY_... | | FxAssignment | getAssignment(String xPath)
| | FxAssignment | getAssignment(long assignmentId)
| | FxDataType | getDataType(long id)
| | List<FxDataType> | getDataTypes()
| | String | getDeactivatedTypesList()
| | ACL | getDefaultACL(ACL.Category category)
| | List<FxAssignment> | getDerivedAssignments(long assignmentId)
| | FxGroup | getGroup(long id)
| | FxGroup | getGroup(String name)
| | List<FxGroupAssignment> | getGroupAssignments()
| | List<FxGroupAssignment> | getGroupAssignments(boolean includeDisabled)
| | List<FxGroup> | getGroups(boolean returnReferenced, boolean returnUnreferenced, boolean returnRootGroups, boolean returnSubGroups)
| | String | getInactiveMandatorList()
| | Mandator | getMandator(long id)
| | Mandator | getMandator(String name)
| | List<Mandator> | getMandators(boolean active, boolean inactive)
| | List<FxProperty> | getProperties(boolean returnReferenced, boolean returnUnreferenced)
| | FxProperty | getProperty(long id)
| | FxProperty | getProperty(String name)
| | List<FxPropertyAssignment> | getPropertyAssignments()
| | List<FxPropertyAssignment> | getPropertyAssignments(boolean includeDisabled)
| | List<FxType> | getReferencingRelationTypes(long typeId)
Gets relation types that contain the type with the specified id as source
or destination of their relations. | | Route | getRoute(long routeId)
Load a given route. | | FxScriptInfo | getScript(long scriptId)
| | FxScriptMapping | getScriptMapping(long scriptId)
| | List<FxScriptMapping> | getScriptMappings()
| | List<FxScriptInfo> | getScripts()
| | FxSelectList | getSelectList(long id)
| | FxSelectList | getSelectList(String name)
| | FxSelectListItem | getSelectListItem(long id)
| | List<FxSelectList> | getSelectLists()
| | Step | getStep(long stepId)
| | Step | getStepByDefinition(long workflowId, long stepDefinitionId)
Return the step defined by its unique step definition id and workflow. | | StepDefinition | getStepDefinition(long id)
Returns a step defined by its unique id. | | List<StepDefinition> | getStepDefinitions()
| | List<Step> | getSteps()
| | List<Step> | getStepsByDefinition(long stepDefinitionId)
Return all steps using a given stepDefinition.. | | List<Step> | getStepsByWorkflow(long workflowId)
Return the steps assigned to a given workflow. | | List<FxPropertyAssignment> | getSystemInternalRootPropertyAssignments()
| | long | getTimeStamp()
| | FxType | getType(String name)
| | FxType | getType(long id)
| | List<FxType> | getTypes(boolean returnBaseTypes, boolean returnDerivedTypes, boolean returnTypes, boolean returnRelations)
| | List<FxType> | getTypesForProperty(long propertyId)
| | Workflow | getWorkflow(long id)
| | List<Workflow> | getWorkflows()
|
| getACL | | ACL getACL(long id)(Code) | | Get an ACL by its id
Parameters:
id - ACL id ACL |
| getACL | | ACL getACL(String name)(Code) | | Get an ACL by its name
Parameters:
name - name of the ACL (case sensitive!) ACL the found ACL |
| getACLs | | List<ACL> getACLs(ACL.Category category)(Code) | | Return all ACLs of the given category.
Parameters:
category - ACL category to be filtered all ACLs of the given category. |
| getACLs | | List<ACL> getACLs(long mandatorId)(Code) | | Return all ACLs of a given mandatorId.
Parameters:
mandatorId - the function returns all ACLs from this mandatorId all ACLs of the given mandator |
| getACLs | | List<ACL> getACLs(long mandatorId, boolean includeForeignAccessible)(Code) | | Return all ACLs of a given mandatorId and category.
Parameters:
mandatorId - the function loads all ACLs from this mandatorId.
Parameters:
includeForeignAccessible - when true, also loads ACLs that the calling user has at least one permission on,even if they belong to another mandator. the ACLs |
| getACLs | | List<ACL> getACLs(long mandatorId, ACL.Category category, boolean includeForeignAccessible)(Code) | | Return all ACLs of a given mandatorId and category.
Parameters:
mandatorId - the function loads all ACLs from this mandatorId.
Parameters:
category - a ACL.CATEGORY_... constant or -1 if the category should be ignored
Parameters:
includeForeignAccessible - when true, also loads ACLs that the calling user has at least one permission on,even if they belong to another mandator. the ACLs |
| getAssignment | | FxAssignment getAssignment(String xPath)(Code) | | Get a FxGroupAssignment or FxPropertyAssignment that matches for XPath (has to include the type/relation name as root)
Parameters:
xPath - requested XPath FxGroupAssignment or FxPropertyAssignment that matches for XPath (has to include the type/relation name as root) |
| getAssignment | | FxAssignment getAssignment(long assignmentId)(Code) | | Get an assignment by its id
Parameters:
assignmentId - assignment id the assignment |
| getDataType | | FxDataType getDataType(long id)(Code) | | Get a data type by its id
Parameters:
id - data type id FxDataType |
| getDeactivatedTypesList | | String getDeactivatedTypesList()(Code) | | Get a comma separated list of deactivated FxTypes
comma separated list of deactivated FxTypes |
| getDefaultACL | | ACL getDefaultACL(ACL.Category category)(Code) | | Get the default ACL for given categors
Parameters:
category - the category to get a default ACL for the default ACL for given categors |
| getDerivedAssignments | | List<FxAssignment> getDerivedAssignments(long assignmentId)(Code) | | Get all assignments that are derived from the requested
Parameters:
assignmentId - the assignment whose derived children are sought after derived assignments |
| getGroup | | FxGroup getGroup(long id)(Code) | | Get a group identified by its id
Parameters:
id - group id FxGroup |
| getGroup | | FxGroup getGroup(String name)(Code) | | Get a group identified by its name
Parameters:
name - group name FxGroup |
| getGroupAssignments | | List<FxGroupAssignment> getGroupAssignments()(Code) | | Get all group assignments that are enabled
enabled group assignments |
| getGroupAssignments | | List<FxGroupAssignment> getGroupAssignments(boolean includeDisabled)(Code) | | Get all group assignments, optionally including disabled
Parameters:
includeDisabled - include disabled assignments? group assignments, optionally including disabled |
| getGroups | | List<FxGroup> getGroups(boolean returnReferenced, boolean returnUnreferenced, boolean returnRootGroups, boolean returnSubGroups)(Code) | | Get groups depending on selection criteria
Parameters:
returnReferenced - return groups that are referenced from a type
Parameters:
returnUnreferenced - return groups that are not referenced from a type
Parameters:
returnRootGroups - return groups from the 'root' level (only checked if returning referenced)
Parameters:
returnSubGroups - return groups that are subgroups of other groups (only checked if returning referenced) FxGroup ArrayList |
| getInactiveMandatorList | | String getInactiveMandatorList()(Code) | | Get a comma separated list of inactive mandators
comma separated list of inactive mandators |
| getMandator | | Mandator getMandator(long id)(Code) | | Get a mandator by its id
Parameters:
id - the mandator id the mandator with the given id |
| getMandator | | Mandator getMandator(String name)(Code) | | Get a mandator by its name
Parameters:
name - the mandator name the mandator of the given name |
| getMandators | | List<Mandator> getMandators(boolean active, boolean inactive)(Code) | | Get a list of all mandators depending on selection criteria
Parameters:
active - return active mandators?
Parameters:
inactive - return inactive mandators? list of all mandators depending on selection criteria |
| getProperties | | List<FxProperty> getProperties(boolean returnReferenced, boolean returnUnreferenced)(Code) | | Get properties depending on selection criteria
Parameters:
returnReferenced - return properties that are referenced from a type
Parameters:
returnUnreferenced - return properties that are not referenced from a type FxProperty iterator |
| getProperty | | FxProperty getProperty(long id)(Code) | | Get a property identified by its id
Parameters:
id - property id FxProperty |
| getProperty | | FxProperty getProperty(String name)(Code) | | Get a property identified by its name
Parameters:
name - property name FxProperty |
| getPropertyAssignments | | List<FxPropertyAssignment> getPropertyAssignments()(Code) | | Get all property assignments that are enabled
enabled property assignments |
| getPropertyAssignments | | List<FxPropertyAssignment> getPropertyAssignments(boolean includeDisabled)(Code) | | Get all property assignments, optionally including disabled
Parameters:
includeDisabled - include disabled assignments? property assignments, optionally including disabled |
| getReferencingRelationTypes | | List<FxType> getReferencingRelationTypes(long typeId)(Code) | | Gets relation types that contain the type with the specified id as source
or destination of their relations.
Parameters:
typeId - id which is referenced by relations list of relation types that contain relations to the type with the specified id |
| getRoute | | Route getRoute(long routeId)(Code) | | Load a given route.
Parameters:
routeId - the route to be loaded the requested route |
| getScript | | FxScriptInfo getScript(long scriptId)(Code) | | Get a script by its id
Parameters:
scriptId - requested script id the script info object |
| getScriptMapping | | FxScriptMapping getScriptMapping(long scriptId)(Code) | | Get the script mapping for the requested script
Parameters:
scriptId - requested script id script mapping |
| getSelectList | | FxSelectList getSelectList(long id)(Code) | | Get the selectlist with the given id
Parameters:
id - requested select list id select list |
| getSelectList | | FxSelectList getSelectList(String name)(Code) | | Get the selectlist with the given name
Parameters:
name - requested select list name select list |
| getSelectListItem | | FxSelectListItem getSelectListItem(long id)(Code) | | Get the selectlist item with the given id
Parameters:
id - requested select list item id select list item |
| getSelectLists | | List<FxSelectList> getSelectLists()(Code) | | Get all available select lists
all available select lists |
| getStep | | Step getStep(long stepId)(Code) | | Get a Step by its id
Parameters:
stepId - step id Step |
| getStepByDefinition | | Step getStepByDefinition(long workflowId, long stepDefinitionId)(Code) | | Return the step defined by its unique step definition id and workflow.
Parameters:
stepDefinitionId - the step definition id
Parameters:
workflowId - the workflow the step has to be in the matching step |
| getStepDefinition | | StepDefinition getStepDefinition(long id)(Code) | | Returns a step defined by its unique id.
Parameters:
id - the unique step definition id the step definition object |
| getSteps | | List<Step> getSteps()(Code) | | Get all defined steps
sll defined steps |
| getStepsByDefinition | | List<Step> getStepsByDefinition(long stepDefinitionId)(Code) | | Return all steps using a given stepDefinition..
Parameters:
stepDefinitionId - the step definition id the matching steps, is a empty result if the stepdefinitionId does not exist or if no steps were found |
| getStepsByWorkflow | | List<Step> getStepsByWorkflow(long workflowId)(Code) | | Return the steps assigned to a given workflow.
Parameters:
workflowId - workflow to return the step definitions for the steps assigned to a given workflow. |
| getSystemInternalRootPropertyAssignments | | List<FxPropertyAssignment> getSystemInternalRootPropertyAssignments()(Code) | | Get all system internal property assignments that are connected
to the virtual root type
system internal property assignments |
| getTimeStamp | | long getTimeStamp()(Code) | | Get the timestamp when this environment was loaded
timestamp when this environment was loaded |
| getType | | FxType getType(String name)(Code) | | Get a type or relation identified by its name
Parameters:
name - type name type or relation identified by its name |
| getType | | FxType getType(long id)(Code) | | Get a type or relation identified by its id
Parameters:
id - type id type or relation identified by its id |
| getTypes | | List<FxType> getTypes(boolean returnBaseTypes, boolean returnDerivedTypes, boolean returnTypes, boolean returnRelations)(Code) | | Get types depending on selection criteria
Parameters:
returnBaseTypes - return types that are not derived from another type
Parameters:
returnDerivedTypes - return types that are derived from another type
Parameters:
returnTypes - return FxTypes
Parameters:
returnRelations - return FxTypes that are relations FxType iterator |
| getTypesForProperty | | List<FxType> getTypesForProperty(long propertyId)(Code) | | Get a list of all types that have assignments of the requested property
Parameters:
propertyId - requested propery list of all types that have assignments of the requested property |
| getWorkflow | | Workflow getWorkflow(long id)(Code) | | Get a Workflow by its id
Parameters:
id - workflow id Workflow |
|
|