| java.lang.Object
 com.flexive.shared.AbstractSelectableObjectWithLabel
com.flexive.shared.structure.FxType
All known Subclasses: com.flexive.shared.structure.FxTypeEdit, com.flexive.core.structure.FxPreloadType,
| Constructor Summary | |
| public | FxType(long id, ACL acl, Workflow workflow, String name, FxString description, FxType parent, TypeStorageMode storageMode, TypeCategory category, TypeMode mode, boolean checkValidity, LanguageMode language, TypeState state, byte permissions, boolean trackHistory, long historyAge, long maxVersions, int maxRelSource, int maxRelDestination, LifeCycleInfo lifeCycleInfo, List<FxType> derivedTypes, List<FxTypeRelation> relations)
|
| CONTACTDATA | | final public static String CONTACTDATA(Code) | | Name of the account contact data type
|
| FOLDER | | final public static String FOLDER(Code) | | Name of the folder data type.
|
| ROOT_ID | | final public static long ROOT_ID(Code) | | Virtual ROOT_ID type
|
| checkValidity | | protected boolean checkValidity(Code) | | |
| historyAge | | protected long historyAge(Code) | | |
| maxRelDestination | | protected int maxRelDestination(Code) | | |
| maxRelSource | | protected int maxRelSource(Code) | | |
| maxVersions | | protected long maxVersions(Code) | | |
| permissions | | protected byte permissions(Code) | | |
| trackHistory | | protected boolean trackHistory(Code) | | |
| FxType | | public FxType(long id, ACL acl, Workflow workflow, String name, FxString description, FxType parent, TypeStorageMode storageMode, TypeCategory category, TypeMode mode, boolean checkValidity, LanguageMode language, TypeState state, byte permissions, boolean trackHistory, long historyAge, long maxVersions, int maxRelSource, int maxRelDestination, LifeCycleInfo lifeCycleInfo, List<FxType> derivedTypes, List<FxTypeRelation> relations)(Code) | | |
| asEditable | | public FxTypeEdit asEditable()(Code) | | Get this FxType as editable
FxTypeEdit |
| buildXPathPrefix | | public String buildXPathPrefix(FxPK pk)(Code) | | Build an XPath prefix for addressing an instance in XPath's
Parameters:
pk - primary key of the instance XPath prefix like "FxType name[@pk=..]" |
| createEmptyData | | public FxGroupData createEmptyData(String xpPrefix) throws FxCreateException(Code) | | Create an empty FxData hierarchy for a new FxContent starting with a
virtual root group.
Parameters:
xpPrefix - XPath prefix like "FxType name[@pk=..]" empty FxData hierarchy
throws:
FxCreateException - on errors |
| createRandomData | | public FxGroupData createRandomData(FxPK pk, FxEnvironment env, Random rnd, int maxMultiplicity) throws FxCreateException(Code) | | Create a base group with random data
Parameters:
pk - primary key of instance that uses this random data
Parameters:
env - environment
Parameters:
rnd - Random to use
Parameters:
maxMultiplicity - the maximum multiplicity for groups random data
throws:
FxCreateException - on errors |
| getACL | | public ACL getACL()(Code) | | Get the ACL of this type
ACL of this type |
| getAssignedGroups | | public List<FxGroupAssignment> getAssignedGroups()(Code) | | Get all group assignments that are attached to the type's root
all group assignments that are attached to the type's root |
| getAssignedProperties | | public List<FxPropertyAssignment> getAssignedProperties()(Code) | | Get all property assignments that are attached to the type's root
all property assignments that are attached to the type's root |
| getAssignmentsForDataType | | public List<FxPropertyAssignment> getAssignmentsForDataType(FxDataType dataType)(Code) | | Get a list of all FxPropertyAssignments connected to this type that are of the given
FxDataType .
Parameters:
dataType - the data type list of all FxPropertyAssignments connected to this type that are of the given data type |
| getAssignmentsForProperty | | public List<FxPropertyAssignment> getAssignmentsForProperty(long propertyId)(Code) | | Get a list of all FxPropertyAssignments connected to this type that are assigned to the requested property
Parameters:
propertyId - requested property id list of all FxPropertyAssignments connected to this type that are assigned to the requested property |
| getBitCodedPermissions | | public byte getBitCodedPermissions()(Code) | | Get the permissions set for this type bit coded
bit coded permissions |
| getCategory | | public TypeCategory getCategory()(Code) | | Get the category of this FxType (System, User, ...)
the category. |
| getDerivedTypes | | public List<FxType> getDerivedTypes()(Code) | | Get all FxTypes that are derived from this Type
Iterator of all derived types |
| getDescription | | public FxString getDescription()(Code) | | Get the description of this FxType
description |
| getDisplayName | | public String getDisplayName()(Code) | | Returrn a localized, human-readable name for the type.
a localized, human-readable name for the type. |
| getHistoryAge | | public long getHistoryAge()(Code) | | Get how many days history is tracked (0 = forever)
how many days history is tracked (0 = forever) |
| getId | | public long getId()(Code) | | Internal id of this FxType
the internal id of this FxType |
| getLanguage | | public LanguageMode getLanguage()(Code) | | How are languages handled? (None, Single, Multiple, ...)
how languages are handled |
| getLifeCycleInfo | | public LifeCycleInfo getLifeCycleInfo()(Code) | | Get information about changes
information about changes |
| getMaxRelDestination | | public int getMaxRelDestination()(Code) | | How many destination instances may be related to this instance in total? (infinte = <0)
how many destination instances may be related to this instance in total? (infinte = <0) |
| getMaxRelSource | | public int getMaxRelSource()(Code) | | How many source instances may be related to this instance in total? (infinte = <0)
how many source instances may be related to this instance in total? (infinte = <0) |
| getMaxVersions | | public long getMaxVersions()(Code) | | Get how many versions of instances are kept (-1 = infinite, 0 = none)
how many versions of instances are kept (-1 = infinite, 0 = none) |
| getMode | | public TypeMode getMode()(Code) | | Is this FxType defining a content or relation?
mode (Content or Relation) |
| getName | | public String getName()(Code) | | Get the name of this FxType
name |
| getParent | | public FxType getParent()(Code) | | If this FxType is derived from another FxType get the 'super' FxType
FxType this one is derived from or null |
| getRelations | | public List<FxTypeRelation> getRelations()(Code) | | Get all possible relation combinations
possible relation combinations |
| getScriptMapping | | public long[] getScriptMapping(FxScriptEvent event)(Code) | | Get the script id's that are mapped to this type for the requested script type
Parameters:
event - requested script event mappings or null if mapping does not exist for this type |
| getScriptedAssignments | | public synchronized List<FxAssignment> getScriptedAssignments(FxScriptEvent event)(Code) | | Get a list with all assignments that have scripts assigned for the given script type
Parameters:
event - script event list with all assignments that have scripts assigned for the given script type |
| getState | | public TypeState getState()(Code) | | Get the state of this type
TypeState |
| getStorageMode | | public TypeStorageMode getStorageMode()(Code) | | Get how is data stored internally.
how data is stored internally |
| getUniqueProperties | | public List<FxProperty> getUniqueProperties()(Code) | | Get all properties used in this type that have a unique constraint set
all properties used in this type that have a unique constraint set |
| getWorkflow | | public Workflow getWorkflow()(Code) | | Getter for the assigned Workflow
Workflow |
| hasScriptMapping | | public boolean hasScriptMapping(FxScriptEvent event)(Code) | | Does this type have mappings for the requested script event type?
Parameters:
event - requested script event type if mappings exist |
| hasScriptedAssignments | | public boolean hasScriptedAssignments()(Code) | | Do scripted assignments exists for this type?
if scripted assignments exist for this type |
| hasUniqueProperties | | public boolean hasUniqueProperties()(Code) | | Do unique properties for this type exist?
if unique properties for this type exist |
| isCheckValidity | | public boolean isCheckValidity()(Code) | | Perform validity checks on instances?
is validity checks are performed on instances |
| isDerived | | public boolean isDerived()(Code) | | Is this FxType derived from another?
if this FxType is derived from another
See Also: FxType.getParent |
| isRelation | | public boolean isRelation()(Code) | | Is this type a relation?
if this type is a relation |
| isTrackHistory | | public boolean isTrackHistory()(Code) | | Track history of changes?
if history of changes is tracked |
| isXPathValid | | public boolean isXPathValid(String XPath, boolean checkProperty)(Code) | | Check if the given XPath is valid for this content
Parameters:
XPath - the XPath to check
Parameters:
checkProperty - should the XPath point to a property? if the XPath is valid or not |
| reloadWorkflow | | public void reloadWorkflow(FxEnvironment environment)(Code) | | Reload this types workflow, internal method, called from the StructureLoader upon Workflow changes
Parameters:
environment - environment with updated workflows |
| useInstancePermissions | | public boolean useInstancePermissions()(Code) | | Use content instance permissions?
if content instance permissions are used |
| usePermissions | | public boolean usePermissions()(Code) | | Use permissions at all?
if permissions are used at all |
| usePropertyPermissions | | public boolean usePropertyPermissions()(Code) | | Use property permissions?
if property permissions are used |
| useStepPermissions | | public boolean useStepPermissions()(Code) | | Use step permissions?
if step permissions are used |
| useTypePermissions | | public boolean useTypePermissions()(Code) | | Use type permissions?
if type permissions are used |
|
|