| java.lang.Object
 com.flexive.shared.content.FxContent
| FxContent | | public class FxContent implements Serializable,Cloneable(Code) | | A content instance
author:
Markus Plesser (markus.plesser@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at) |
| Constructor Summary | |
| public | FxContent(FxPK pk, long typeId, boolean relation, long mandatorId, long aclId, long stepId, int maxVersion, int liveVersion, boolean active, long mainLanguage, FxPK relatedSource, FxPK relatedDestination, int relatedSourcePosition, int relatedDestinationPosition, LifeCycleInfo lifeCycleInfo, FxGroupData data, long binaryPreviewId, long binaryPreviewACL)
Constructor
Parameters:
pk - primary key
Parameters:
typeId - used type id
Parameters:
relation - is this a content for a relation?
Parameters:
mandatorId - mandator id
Parameters:
aclId - ACL id
Parameters:
stepId - step id
Parameters:
maxVersion - max. |
| POSITION_BOTTOM | | final public static int POSITION_BOTTOM(Code) | | Bottommost position for relation positioning
|
| POSITION_TOP | | final public static int POSITION_TOP(Code) | | Topmost position for relation positioning
|
| FxContent | | public FxContent(FxPK pk, long typeId, boolean relation, long mandatorId, long aclId, long stepId, int maxVersion, int liveVersion, boolean active, long mainLanguage, FxPK relatedSource, FxPK relatedDestination, int relatedSourcePosition, int relatedDestinationPosition, LifeCycleInfo lifeCycleInfo, FxGroupData data, long binaryPreviewId, long binaryPreviewACL)(Code) | | Constructor
Parameters:
pk - primary key
Parameters:
typeId - used type id
Parameters:
relation - is this a content for a relation?
Parameters:
mandatorId - mandator id
Parameters:
aclId - ACL id
Parameters:
stepId - step id
Parameters:
maxVersion - max. version for this instance
Parameters:
liveVersion - live version for this instance (0=no live version exists)
Parameters:
active - is this instance active
Parameters:
mainLanguage - main language
Parameters:
relatedSource - related source instance (only if this is a relation)
Parameters:
relatedDestination - related destination instance (only if this is a relation)
Parameters:
relatedSourcePosition - position for source instance (only if this is a relation)
Parameters:
relatedDestinationPosition - position for destination instance (only if this is a relation)
Parameters:
lifeCycleInfo - lifecycle
Parameters:
data - data
Parameters:
binaryPreviewId - id of the preview binary
Parameters:
binaryPreviewACL - id of the ACL of the preview binary |
| containsValue | | public boolean containsValue(String XPath)(Code) | | Check if a value exists for the given XPath that is not empty
Parameters:
XPath - the XPath to check if a value exists for the given XPath that is not empty |
| copy | | public FxContent copy()(Code) | | Create an independent copy of this FxContent
a copy of this FxContent |
| getAclId | | public long getAclId()(Code) | | Getter for the ACL id
ACL id |
| getAllPropertyXPaths | | public List<String> getAllPropertyXPaths()(Code) | | Get a list of all property XPaths contained in this content in correct order
list of all property XPaths contained in this content in correct order |
| getAllXPaths | | public List<String> getAllXPaths(String groupPostfix)(Code) | | Get a list of all XPaths contained in this content in correct order
Parameters:
groupPostfix - String to append to found groups (useful to append "/" to kind of mark those XPaths as group XPaths) list of all XPaths contained in this content in correct order |
| getBinaryPreviewACL | | public long getBinaryPreviewACL()(Code) | | ACL that is needed to view the preview image
ACL that is needed to view the preview image |
| getBinaryPreviewId | | public long getBinaryPreviewId()(Code) | | Id of the binary used for previews
id of the binary used for previews |
| getId | | public long getId()(Code) | | Getter for the Id
id |
| getLifeCycleInfo | | public LifeCycleInfo getLifeCycleInfo()(Code) | | Get the lifecycle information
lifecycle information |
| getLiveVersion | | public int getLiveVersion()(Code) | | Get the live version of this content or 0 if no live version exists
live version of this content or 0 if no live version exists |
| getMainLanguage | | public long getMainLanguage()(Code) | | Get the main language
main language |
| getMandatorId | | public long getMandatorId()(Code) | | Getter for the mandator id
mandator id |
| getMaxVersion | | public int getMaxVersion()(Code) | | Get the max version of this content
max version of this content |
| getPk | | public FxPK getPk()(Code) | | Getter for the primary key
primary key |
| getPropertyData | | public List<FxPropertyData> getPropertyData(long propertyId, boolean includeEmpty)(Code) | | Get a list of all FxPropertyData entries that are assigned to propertyId
Parameters:
propertyId - the property id requested
Parameters:
includeEmpty - include empty data instances? list of all FxPropertyData entries that are assigned to propertyId |
| getRelatedDestination | | public FxPK getRelatedDestination()(Code) | | If this is a relation get the assigned "to" (or destination) instance
the assigned "to" (or destination) instance |
| getRelatedDestinationPosition | | public int getRelatedDestinationPosition()(Code) | | Get the position for the destination content instance
position for the destination content instance |
| getRelatedSource | | public FxPK getRelatedSource()(Code) | | If this is a relation get the assigned "from" (or source) instance
the assigned "from" (or source) instance |
| getRelatedSourcePosition | | public int getRelatedSourcePosition()(Code) | | Get the position for the source content instance
position for the source content instance |
| getRootGroup | | public FxGroupData getRootGroup()(Code) | | Get the (virtual) root group of this content
root group |
| getStepId | | public long getStepId()(Code) | | Getter for the step id
step id |
| getTypeId | | public long getTypeId()(Code) | | Getter for the type id
type id |
| getVersion | | public int getVersion()(Code) | | Getter for the version
version |
| isActive | | public boolean isActive()(Code) | | Is this content active?
content is active |
| isLiveVersion | | public boolean isLiveVersion()(Code) | | Is this content instance the live version
if content instance the live version |
| isMaxVersion | | public boolean isMaxVersion()(Code) | | Is this content instance the max version
if content instance the max version |
| isPreviewAvailable | | public boolean isPreviewAvailable()(Code) | | Is a preview available that is not a default image?
preview available |
| isRelation | | public boolean isRelation()(Code) | | Is this content a relation?
content is relation |
| isXPathValid | | public boolean isXPathValid(String XPath, boolean checkProperty)(Code) | | Check if the given XPath is valid for this content.
This is a shortcut to the corresponding type's method!
Parameters:
XPath - the XPath to check
Parameters:
checkProperty - should the XPath point to a property? if the XPath is valid or not
See Also: FxType.isXPathValid(Stringboolean) |
| matchesPk | | public boolean matchesPk(FxPK otherPk)(Code) | | Checks if the given PK matches this content. This allows to match a generic PK (i.e. without
a distinct version, but
FxPK.LIVE or
FxPK.MAX ), which the FxPK equals method
cannot do.
Parameters:
otherPk - the PK to be matched true if otherPk matches this content |
| move | | public void move(String XPath, int delta) throws FxInvalidParameterException, FxNotFoundException(Code) | | Move data (group or property) within its hierarchy for delta
positions up or down depending on the sign of delta without wrapping
around if top or bottom position is reached.
If delta is Integer.MAX_VALUE the data will always be placed at the bottom,
Integer.MIN_VALUE will always place it at the top.
Parameters:
XPath - FQ XPath
Parameters:
delta - relative number of positions to move
throws:
FxInvalidParameterException - for invalid XPath
throws:
FxNotFoundException - XPath does not exist for this content |
| resetBinaryPreview | | public void resetBinaryPreview()(Code) | | Reset the preview image to show the default BinaryDescriptor.SYS_UNKNOWN image.
See Also: BinaryDescriptor.SYS_UNKNOWN |
| resolveBinaryPreview | | public void resolveBinaryPreview()(Code) | | Internal method that tries to find a matching preview image.
Searches for images and then regular binaries (preview is then set matching the mime type display).
If neither are found the BinaryDescriptor.SYS_UNKNOWN image is used
See Also: com.flexive.shared.value.BinaryDescriptor.SYS_UNKNOWN |
| setAclId | | public void setAclId(long aclId)(Code) | | Set the ACL id
Parameters:
aclId - the ACL id |
| setActive | | public void setActive(boolean active)(Code) | | (De-)activate this content
Parameters:
active - active flag |
| setBinaryPreview | | public void setBinaryPreview(String XPath)(Code) | | Set the binary preview to an XPath.
Illegal or non-existing values will be ignored!
Parameters:
XPath - the XPath of the requested binary to set as preview |
| setBinaryPreview | | public void setBinaryPreview(long binaryId)(Code) | | Set the binary preview.
Illegal or non-existing values will be ignored!
Parameters:
binaryId - if of the requested binary to set as preview |
| setMainLanguage | | public void setMainLanguage(long mainLanguage)(Code) | | Set the main language
Parameters:
mainLanguage - main language |
| setRelatedDestination | | public FxContent setRelatedDestination(FxPK dst)(Code) | | Set the primary key of the destination relation
Parameters:
dst - destination relation this |
| setRelatedDestinationPosition | | public void setRelatedDestinationPosition(int relatedDestinationPosition)(Code) | | |
| setRelatedSource | | public FxContent setRelatedSource(FxPK src)(Code) | | Set the primary key of the source relation
Parameters:
src - source relation this |
| setStepId | | public void setStepId(long stepId)(Code) | | Set the workflow step id
Parameters:
stepId - workflow step id |
|
|