public interface FxEnvironment
extends java.io.Serializable
Modifier and Type | Method and Description |
---|---|
boolean |
aclExists(java.lang.String name)
Check if an ACL of the given name exists
|
boolean |
assignmentExists(java.lang.String xPath)
Check if an assignment with the requested XPath exists
|
ACL |
getACL(long id)
Get an ACL by its id
|
ACL |
getACL(java.lang.String name)
Get an ACL by its name
|
java.util.List<ACL> |
getACLs()
Get all ACL's
|
java.util.List<ACL> |
getACLs(ACLCategory category)
Return all ACLs of the given category.
|
java.util.List<ACL> |
getACLs(long mandatorId)
Return all ACLs of a given mandatorId.
|
java.util.List<ACL> |
getACLs(long mandatorId,
ACLCategory category,
boolean includeForeignAccessible)
Return all ACLs of a given mandatorId and category.
|
java.util.List<ACL> |
getACLs(long mandatorId,
boolean includeForeignAccessible)
Return all ACLs of a given mandatorId and category.
|
FxAssignment |
getAssignment(long assignmentId)
Get an assignment by its id
|
FxAssignment |
getAssignment(java.lang.String xPath)
Get a FxGroupAssignment or FxPropertyAssignment that matches for XPath (has to include the type/relation name as root)
|
FxDataType |
getDataType(long id)
Get a data type by its id
|
java.util.List<FxDataType> |
getDataTypes()
Get data types
|
java.lang.String |
getDeactivatedTypesList()
Get a comma separated list of deactivated FxTypes
|
ACL |
getDefaultACL(ACLCategory category)
Get the default ACL for given categors
|
java.util.List<FxAssignment> |
getDerivedAssignments(long assignmentId)
Get all assignments that are derived from the requested
|
java.util.List<FxFlatStorageMapping> |
getFlatStorageMappings(java.lang.String storage,
long typeId,
int level)
Get FxFlatStorage Mappings for the requested storage, type and level
|
FxGroup |
getGroup(long id)
Get a group identified by its id
|
FxGroup |
getGroup(java.lang.String name)
Get a group identified by its name
|
java.util.List<FxGroupAssignment> |
getGroupAssignments()
Get all group assignments that are enabled
|
java.util.List<FxGroupAssignment> |
getGroupAssignments(boolean includeDisabled)
Get all group assignments, optionally including disabled
|
java.util.List<FxGroupAssignment> |
getGroupAssignments(long groupId,
boolean includeDisabled)
Get all group assignments for a given id, optionally including disabled assignments
|
java.util.List<FxGroup> |
getGroups(boolean returnReferenced,
boolean returnUnreferenced,
boolean returnRootGroups,
boolean returnSubGroups)
Get groups depending on selection criteria
|
java.lang.String |
getInactiveMandatorList()
Get a comma separated list of inactive mandators
|
FxLanguage |
getLanguage(long id)
Return the language for the given ID.
|
FxLanguage |
getLanguage(java.lang.String isoCode)
Return the language for the given ISO code.
|
java.util.List<FxLanguage> |
getLanguages()
Return all activated languages.
|
Mandator |
getMandator(long id)
Get a mandator by its id
|
Mandator |
getMandator(java.lang.String name)
Get a mandator by its name
|
java.util.List<Mandator> |
getMandators(boolean active,
boolean inactive)
Get a list of all mandators depending on selection criteria
|
FxType |
getMimeTypeMatch(java.lang.String mimeType)
Return the closest matching FxType (any derived type of DocumentFile) for a given mime type
|
java.util.List<FxProperty> |
getProperties(boolean returnReferenced,
boolean returnUnreferenced)
Get properties depending on selection criteria
|
FxProperty |
getProperty(long id)
Get a property identified by its id
|
FxProperty |
getProperty(java.lang.String name)
Get a property identified by its name
|
FxPropertyAssignment |
getPropertyAssignment(long id)
Return the property assignment for the given ID.
|
FxPropertyAssignment |
getPropertyAssignment(java.lang.String xpath)
Return the property assignment that matches the given XPath (has to include the type/relation name as root)
|
java.util.List<FxPropertyAssignment> |
getPropertyAssignments()
Get all property assignments that are enabled
|
java.util.List<FxPropertyAssignment> |
getPropertyAssignments(boolean includeDisabled)
Get all property assignments, optionally including disabled
|
java.util.List<FxPropertyAssignment> |
getPropertyAssignments(long propertyId,
boolean includeDisabled)
Get the property assignments for a given property.
|
java.util.List<FxPropertyAssignment> |
getReferencingPropertyAssignments(long propertyId)
Returns all property assignments that are referencing this property which the
current user may see, excluding the system internal assignments.
|
java.util.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)
Get a script by its id
|
FxScriptInfo |
getScript(java.lang.String name)
Get a script by its name (which is unique)
|
FxScriptMapping |
getScriptMapping(long scriptId)
Get the script mapping for the requested script
|
java.util.List<FxScriptMapping> |
getScriptMappings()
Get all script mappings
|
java.util.List<FxScriptInfo> |
getScripts()
Get all scripts
|
FxScriptSchedule |
getScriptSchedule(long scriptScheduleId)
Get a script schedule by its id
|
java.util.List<FxScriptSchedule> |
getScriptSchedules()
Get all script schedules
|
java.util.List<FxScriptSchedule> |
getScriptSchedulesForScript(long scriptId)
Get all script schedules for a script
|
FxSelectList |
getSelectList(long id)
Get the selectlist with the given id
|
FxSelectList |
getSelectList(java.lang.String name)
Get the selectlist with the given name
|
FxSelectListItem |
getSelectListItem(FxSelectList list,
java.lang.String name)
Get the selectlist item with the given name in the given list
|
FxSelectListItem |
getSelectListItem(long id)
Get the selectlist item with the given id
|
java.util.List<FxSelectList> |
getSelectLists()
Get all available select lists
|
Step |
getStep(long stepId)
Get a Step by its id
|
Step |
getStep(long workflowId,
java.lang.String stepName)
Get a Step by its name
|
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.
|
StepDefinition |
getStepDefinition(java.lang.String name)
Returns a step defined by its unique name.
|
java.util.List<StepDefinition> |
getStepDefinitions()
Get all defined step definitions
|
java.util.List<Step> |
getSteps()
Get all defined steps
|
java.util.List<Step> |
getStepsByDefinition(long stepDefinitionId)
Return all steps using a given stepDefinition..
|
java.util.List<Step> |
getStepsByWorkflow(long workflowId)
Return the steps assigned to a given workflow.
|
java.util.List<FxPropertyAssignment> |
getSystemInternalRootPropertyAssignments()
Get all system internal property assignments that are connected
to the virtual root type
|
long |
getTimeStamp()
Get the timestamp when this environment was loaded
|
FxType |
getType(long id)
Get a type or relation identified by its id
|
FxType |
getType(java.lang.String name)
Get a type or relation identified by its name
|
java.util.List<FxType> |
getTypes()
Returns all defined types.
|
java.util.List<FxType> |
getTypes(boolean returnBaseTypes,
boolean returnDerivedTypes,
boolean returnTypes,
boolean returnRelations)
Get types depending on selection criteria
|
java.util.List<FxType> |
getTypesForProperty(long propertyId)
Get a list of all types that have assignments of the requested property
|
UserGroup |
getUserGroup(long id)
Get a user group by id
|
UserGroup |
getUserGroup(java.lang.String name)
Get a user group by id
|
java.util.List<UserGroup> |
getUserGroups()
Return all defined user groups
|
Workflow |
getWorkflow(long id)
Get a Workflow by its id
|
Workflow |
getWorkflow(java.lang.String name)
Get a Workflow by its name
|
java.util.List<Workflow> |
getWorkflows()
Get all workflows
|
boolean |
groupAssignmentExists(java.lang.String xPath)
Check if a group assignment with the requested XPath exists
|
boolean |
groupExists(java.lang.String name)
Check if a group with the requested name exists
|
boolean |
groupExistsInType(java.lang.String typeName,
java.lang.String groupName)
Check if a group exists within the given type
|
boolean |
isLanguageActive(long id)
Return if the requested language id is active
|
boolean |
isLanguageActive(java.lang.String isoCode)
Return if the requested language iso 2-digit code is active
|
boolean |
propertyAssignmentExists(java.lang.String xPath)
Check if a property assignment with the requested XPath exists
|
boolean |
propertyExists(java.lang.String name)
Check if a property with the requested name exists
|
boolean |
propertyExistsInType(java.lang.String typeName,
java.lang.String propertyName)
Check if a property exists within the given type
|
boolean |
scriptExists(java.lang.String name)
Check if a script with the given name exists
|
boolean |
selectListExists(java.lang.String name)
Check if a FxSelectList with the given name exists
|
boolean |
typeExists(java.lang.String name)
Check if a type with the given name exists
|
java.util.List<FxDataType> getDataTypes()
FxDataType getDataType(long id)
id
- data type idACL getACL(long id)
id
- ACL idACL getACL(java.lang.String name)
name
- name of the ACL (case sensitive!)boolean aclExists(java.lang.String name)
name
- name of the ACLjava.util.List<ACL> getACLs()
java.util.List<ACL> getACLs(ACLCategory category)
category
- ACL category to be filteredjava.util.List<ACL> getACLs(long mandatorId)
mandatorId
- the function returns all ACLs from this mandatorIdjava.util.List<ACL> getACLs(long mandatorId, boolean includeForeignAccessible)
mandatorId
- the function loads all ACLs from this mandatorId.includeForeignAccessible
- when true, also loads ACLs that the calling user has at least one permission on,
even if they belong to another mandator.java.util.List<ACL> getACLs(long mandatorId, ACLCategory category, boolean includeForeignAccessible)
mandatorId
- the function loads all ACLs from this mandatorId.category
- a ACL.CATEGORY_... constant or -1
if the category should be ignoredincludeForeignAccessible
- when true, also loads ACLs that the calling user has at least one permission on,
even if they belong to another mandator.ACL getDefaultACL(ACLCategory category)
category
- the category to get a default ACL forWorkflow getWorkflow(long id)
id
- workflow idWorkflow getWorkflow(java.lang.String name)
name
- workflow namejava.util.List<Workflow> getWorkflows()
Mandator getMandator(long id)
id
- the mandator idMandator getMandator(java.lang.String name)
name
- the mandator namejava.util.List<Mandator> getMandators(boolean active, boolean inactive)
active
- return active mandators?inactive
- return inactive mandators?java.util.List<FxGroup> getGroups(boolean returnReferenced, boolean returnUnreferenced, boolean returnRootGroups, boolean returnSubGroups)
returnReferenced
- return groups that are referenced from a typereturnUnreferenced
- return groups that are not referenced from a typereturnRootGroups
- return groups from the 'root' level (only checked if returning referenced)returnSubGroups
- return groups that are subgroups of other groups (only checked if returning referenced)FxGroup getGroup(long id)
id
- group idFxGroup getGroup(java.lang.String name)
name
- group namejava.util.List<FxProperty> getProperties(boolean returnReferenced, boolean returnUnreferenced)
returnReferenced
- return properties that are referenced from a typereturnUnreferenced
- return properties that are not referenced from a typeFxProperty getProperty(long id)
id
- property idFxProperty getProperty(java.lang.String name)
name
- property nameboolean propertyExists(java.lang.String name)
name
- name of the propertyboolean propertyExistsInType(java.lang.String typeName, java.lang.String propertyName)
typeName
- the type's namepropertyName
- the property's nameboolean groupExistsInType(java.lang.String typeName, java.lang.String groupName)
typeName
- the type's namegroupName
- the group's nameboolean assignmentExists(java.lang.String xPath)
xPath
- XPath of the assignmentboolean propertyAssignmentExists(java.lang.String xPath)
xPath
- XPath of the assignmentboolean groupAssignmentExists(java.lang.String xPath)
xPath
- XPath of the assignmentboolean groupExists(java.lang.String name)
name
- name of the groupjava.util.List<FxPropertyAssignment> getPropertyAssignments()
java.util.List<FxPropertyAssignment> getSystemInternalRootPropertyAssignments()
java.util.List<FxPropertyAssignment> getPropertyAssignments(boolean includeDisabled)
includeDisabled
- include disabled assignments?java.util.List<FxPropertyAssignment> getPropertyAssignments(long propertyId, boolean includeDisabled)
propertyId
- the property IDincludeDisabled
- include disabled assignments?java.util.List<FxGroupAssignment> getGroupAssignments()
java.util.List<FxGroupAssignment> getGroupAssignments(boolean includeDisabled)
includeDisabled
- include disabled assignments?java.util.List<FxGroupAssignment> getGroupAssignments(long groupId, boolean includeDisabled)
groupId
- the group's id for which to get the assignmentsincludeDisabled
- include disabled assignments?FxAssignment getAssignment(java.lang.String xPath)
xPath
- requested XPathFxPropertyAssignment getPropertyAssignment(java.lang.String xpath)
xpath
- requested xpathFxPropertyAssignment getPropertyAssignment(long id)
id
- the requested IDFxAssignment getAssignment(long assignmentId)
assignmentId
- assignment idjava.util.List<FxAssignment> getDerivedAssignments(long assignmentId)
assignmentId
- the assignment whose derived children are sought afterjava.util.List<FxPropertyAssignment> getReferencingPropertyAssignments(long propertyId)
propertyId
- the property which is referencedFxType getType(java.lang.String name)
name
- type nameboolean typeExists(java.lang.String name)
name
- type name to check forjava.util.List<FxType> getTypes()
java.util.List<FxType> getTypes(boolean returnBaseTypes, boolean returnDerivedTypes, boolean returnTypes, boolean returnRelations)
returnBaseTypes
- return types that are not derived from another typereturnDerivedTypes
- return types that are derived from another typereturnTypes
- return FxTypesreturnRelations
- return FxTypes that are relationsjava.util.List<FxType> getReferencingRelationTypes(long typeId)
typeId
- id which is referenced by relationsFxType getType(long id)
id
- type idStepDefinition getStepDefinition(long id)
id
- the unique step definition idStepDefinition getStepDefinition(java.lang.String name)
name
- the unique step definition idjava.util.List<StepDefinition> getStepDefinitions()
java.util.List<Step> getSteps()
Step getStepByDefinition(long workflowId, long stepDefinitionId)
stepDefinitionId
- the step definition idworkflowId
- the workflow the step has to be injava.util.List<Step> getStepsByDefinition(long stepDefinitionId)
stepDefinitionId
- the step definition idjava.util.List<Step> getStepsByWorkflow(long workflowId)
workflowId
- workflow to return the step definitions forStep getStep(long stepId)
stepId
- step idStep getStep(long workflowId, java.lang.String stepName)
workflowId
- id of the workflowstepName
- name of the stepRoute getRoute(long routeId)
routeId
- the route to be loadedjava.util.List<FxSelectList> getSelectLists()
FxSelectList getSelectList(long id)
id
- requested select list idFxSelectList getSelectList(java.lang.String name)
name
- requested select list nameboolean selectListExists(java.lang.String name)
name
- name of the select listFxSelectListItem getSelectListItem(long id)
id
- requested select list item idFxSelectListItem getSelectListItem(FxSelectList list, java.lang.String name)
list
- the list containing the itemname
- requested select list item namejava.util.List<FxScriptInfo> getScripts()
java.util.List<FxScriptMapping> getScriptMappings()
FxScriptMapping getScriptMapping(long scriptId)
scriptId
- requested script idFxScriptInfo getScript(long scriptId)
scriptId
- requested script idFxScriptInfo getScript(java.lang.String name)
name
- requested script namejava.util.List<FxScriptSchedule> getScriptSchedules()
FxScriptSchedule getScriptSchedule(long scriptScheduleId)
scriptScheduleId
- requested script schedule idjava.util.List<FxScriptSchedule> getScriptSchedulesForScript(long scriptId)
scriptId
- requested script idboolean scriptExists(java.lang.String name)
name
- script name to checklong getTimeStamp()
java.util.List<FxType> getTypesForProperty(long propertyId)
propertyId
- requested properyjava.lang.String getInactiveMandatorList()
java.lang.String getDeactivatedTypesList()
java.util.List<FxFlatStorageMapping> getFlatStorageMappings(java.lang.String storage, long typeId, int level)
storage
- flat storagetypeId
- type idlevel
- leveljava.util.List<FxLanguage> getLanguages()
FxLanguage getLanguage(long id)
id
- the language IDFxLanguage getLanguage(java.lang.String isoCode)
isoCode
- the language ISO codeboolean isLanguageActive(long id)
id
- language idboolean isLanguageActive(java.lang.String isoCode)
isoCode
- the language ISO codeFxType getMimeTypeMatch(java.lang.String mimeType)
mimeType
- e.g. application/pdf as a Stringjava.util.List<UserGroup> getUserGroups()
UserGroup getUserGroup(long id)
id
- id of the user groupnull
if not foundUserGroup getUserGroup(java.lang.String name)
name
- name of the user groupnull
if not found