Uses of Class
com.flexive.shared.content.FxPK

Packages that use FxPK
com.flexive.shared Shared classes used by all flexive modules. 
com.flexive.shared.cmis.search   
com.flexive.shared.content Classes for representing flexive contents, most notable FxContent and FxPK
com.flexive.shared.interfaces Local and remote interfaces of the flexive EJB engines. 
com.flexive.shared.media Utility classes for dealing with media data. 
com.flexive.shared.scripting.groovy Groovy-specific helper classes, for example a Builder for structural types. 
com.flexive.shared.search Value classes for FxSQL search results. 
com.flexive.shared.security Data classes for flexive's security layer, like ACLs or roles. 
com.flexive.shared.structure Classes for the representation of flexive data structures. 
com.flexive.shared.tree Data objects for the tree engine. 
com.flexive.shared.value Multilingual value types for flexive contents. 
 

Uses of FxPK in com.flexive.shared
 

Methods in com.flexive.shared with type parameters of type FxPK
static
<T extends FxPK>
FxReferenceMetaData<T>
FxReferenceMetaData.findByContent(java.util.List<FxReferenceMetaData<T>> items, T reference)
          Returns the item that matches the given reference, or null if no such item was found.
 

Methods in com.flexive.shared that return FxPK
 FxPK FxLock.getLockedPK()
          Getter for the FxPK of the locked content
static FxPK XPathElement.getPK(java.lang.String xPath)
          Extract the primary key stored in the given XPath.
 

Methods in com.flexive.shared with parameters of type FxPK
 java.lang.String ContentLinkFormatter.format(java.lang.String formatString, FxPK pk)
          Uses the given format string to create a hyperlink for the given primary key.
static FxCachedContent CacheAdmin.getCachedContent(FxPK pk)
          Try to obtain a cached copy of a content identified by its primary key, will return null if not cached
 

Constructors in com.flexive.shared with parameters of type FxPK
FxLock(FxLockType lockType, long created, long expires, long userId, FxPK lockedPK)
          Ctor for a content lock
 

Uses of FxPK in com.flexive.shared.cmis.search
 

Methods in com.flexive.shared.cmis.search that return FxPK
 FxPK CmisResultValue.getPk()
          Return the primary key of a content selected with the ObjectId property.
 

Uses of FxPK in com.flexive.shared.content
 

Methods in com.flexive.shared.content that return FxPK
static FxPK FxPK.createNewPK()
          Create a new primary key
static FxPK FxPK.fromObject(java.lang.Object value)
          Extract a PK from the given object.
static FxPK FxPK.fromString(java.lang.String value)
          Construct a primary key from a String
 FxPK FxContentSecurityInfo.getPk()
          Get the primary key of the content instance this info relates to
 FxPK FxContent.getPk()
          Getter for the primary key
 FxPK FxContent.getRelatedDestination()
          If this is a relation get the assigned "to" (or destination) instance
 FxPK FxContent.getRelatedSource()
          If this is a relation get the assigned "from" (or source) instance
 

Methods in com.flexive.shared.content that return types with arguments of type FxPK
static java.util.List<FxPK> FxPK.getPks(java.util.Collection<java.lang.Long> ids)
          Wrap the content IDs in FxPK objects.
 

Methods in com.flexive.shared.content with parameters of type FxPK
 int FxPK.compareTo(FxPK o)
           
 boolean FxContentVersionInfo.containsVersion(FxPK pk)
          Check if the requested Pk's version exists
 FxCachedContent FxCachedContentContainer.get(FxPK pk)
          Try to get a content by its primary key, will return null if not found
 boolean FxContent.matchesPk(FxPK otherPk)
          Checks if the given PK matches the content PK.
 FxContent FxContent.setRelatedDestination(FxPK dst)
          Set the primary key of the destination relation
 FxContent FxContent.setRelatedSource(FxPK src)
          Set the primary key of the source relation
 

Method parameters in com.flexive.shared.content with type arguments of type FxPK
static java.util.List<java.lang.Long> FxPK.getIds(java.util.Collection<? extends FxPK> pks)
          Extracts the IDs of the given PK collection.
 

Constructors in com.flexive.shared.content with parameters of type FxPK
FxContent(FxPK pk, FxLock lock, 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
FxContentSecurityInfo(FxPK pk, long ownerId, long previewId, long typeId, long mandatorId, byte typePermissions, long typeACL, long stepACL, java.util.List<java.lang.Long> contentACLs, long previewACL, java.util.List<java.lang.Long> usedPropertyACLs, FxLock lock)
          Constructor
 

Uses of FxPK in com.flexive.shared.interfaces
 

Methods in com.flexive.shared.interfaces that return FxPK
 FxPK ContentEngine.createNewVersion(FxContent content)
          Create a new version for an existing content instance
 FxPK ContentEngine.save(FxContent content)
          Store an existing content or create a new one
 

Methods in com.flexive.shared.interfaces that return types with arguments of type FxPK
 java.util.List<FxReferenceMetaData<FxPK>> BriefcaseEngine.getMetaData(long briefcaseId)
          Loads the metadata instance(s) associated to the briefcase items.
 FxReferenceMetaData<FxPK> BriefcaseEngine.getMetaData(long briefcaseId, FxPK pk)
          Loads the metadata instance(s) associated to given briefcase item.
 java.util.List<FxPK> ContentEngine.getPKsForType(long typeId, boolean onePkPerInstance)
           Returns all primary keys for the given type.
 

Methods in com.flexive.shared.interfaces with parameters of type FxPK
 void ContentEngine.convertContentType(FxPK contentPK, long destinationTypeId, boolean allowLossy, boolean allVersions)
          Convert (all versions of) a given content to another content type The destinationType must either be derived from the given content's type or must be the parent of the given content's type
 FxLock ContentEngine.extendLock(FxPK pk, long duration)
          Extend an existing lock for the given duration (duration will be added to current expire time).
 FxTreeNode TreeEngine.findChild(FxTreeMode mode, long nodeId, FxPK pk)
          Find a (direct) child with the given PK under the node nodeId.
 long ContentEngine.getBinaryId(FxPK pk, java.lang.String xpath, FxLanguage language)
          Get the binary id for the given XPath.
 long ContentEngine.getBinaryId(FxPK pk, java.lang.String xpath, FxLanguage language, boolean fallbackToDefault)
          Get the binary id for the given XPath.
 FxContentSecurityInfo ContentEngine.getContentSecurityInfo(FxPK pk)
          Get all security relevant information about a content instance identified by its primary key
 FxContentVersionInfo ContentEngine.getContentVersionInfo(FxPK id)
          Get information about the versions used for a content id
 FxLock ContentEngine.getLock(FxPK pk)
          Get the lock for a primary key.
 FxReferenceMetaData<FxPK> BriefcaseEngine.getMetaData(long briefcaseId, FxPK pk)
          Loads the metadata instance(s) associated to given briefcase item.
 int ContentEngine.getReferencedContentCount(FxPK pk)
          Get the number of references that exist for the requested content
 FxContent ContentEngine.load(FxPK pk)
          Load a content
 Account AccountEngine.loadForContactData(FxPK contactDataPK)
          Load the account that belongs to the given contact data
 FxLock ContentEngine.lock(FxLockType lockType, FxPK pk)
          Lock an instance
 FxLock ContentEngine.lock(FxLockType lockType, FxPK pk, long duration)
          Lock an instance
 void ContentEngine.remove(FxPK pk)
          Remove a content
 void ContentEngine.removeVersion(FxPK pk)
          Remove a content's version.
 FxLock ContentEngine.takeOverLock(FxPK pk)
          Take over a lock held by another user (if permitted)
 void HistoryTrackerEngine.track(FxType type, FxPK pk, java.lang.String data, java.lang.String key, java.lang.Object... args)
          Write a history entry for a content instance
 void ContentEngine.unlock(FxPK pk)
          Unlock a locked instance.
 

Method parameters in com.flexive.shared.interfaces with type arguments of type FxPK
 void BriefcaseEngine.addItems(long id, java.util.Collection<FxPK> contents)
          Add the given items to the briefcase.
 void BriefcaseEngine.mergeMetaData(long id, java.util.Collection<FxReferenceMetaData<FxPK>> metaData)
          Merges the given metadata fields into the existing metadata stored in the items.
 void BriefcaseEngine.moveItems(long fromId, long toId, java.util.Collection<FxPK> contents)
          Moves items from one briefcase to another.
 void BriefcaseEngine.removeItems(long id, java.util.Collection<FxPK> contents)
          Removes the given items from the briefcase.
 void BriefcaseEngine.setItems(long id, java.util.Collection<FxPK> contents)
          Replace the current briefcase content with the given objects (i.e.
 void BriefcaseEngine.setMetaData(long id, java.util.Collection<FxReferenceMetaData<FxPK>> metaData)
          Replaces the current metadata for the given items.
 void BriefcaseEngine.updateItems(long id, java.util.Collection<FxPK> addContents, java.util.Collection<FxPK> removeContents)
          Adds/removes the given items for the briefcase.
 void BriefcaseEngine.updateItems(long id, java.util.Collection<FxPK> addContents, java.util.Collection<FxPK> removeContents)
          Adds/removes the given items for the briefcase.
 

Uses of FxPK in com.flexive.shared.media
 

Methods in com.flexive.shared.media that return FxPK
 FxPK FxMediaSelector.getPK()
          Get the primary key
 

Methods in com.flexive.shared.media with parameters of type FxPK
 FxMediaSelector FxMediaSelector.setPK(FxPK pk)
          Setter for the primary key
 

Constructors in com.flexive.shared.media with parameters of type FxPK
FxMediaSelector(FxPK pk)
          Ctor
 

Uses of FxPK in com.flexive.shared.scripting.groovy
 

Constructors in com.flexive.shared.scripting.groovy with parameters of type FxPK
GroovyContentBuilder(FxPK pk)
          Create a content builder for the given instance.
 

Uses of FxPK in com.flexive.shared.search
 

Fields in com.flexive.shared.search declared as FxPK
static FxPK FxEmptyResultSet.EMPTY_PK
           
 

Methods in com.flexive.shared.search that return FxPK
 FxPK FxResultRow.getPk(int column)
           
 FxPK FxResultRow.getPk(java.lang.String columnName)
           
 

Methods in com.flexive.shared.search that return types with arguments of type FxPK
 FxReferenceMetaData<FxPK> FxResultRow.getMetaData(int column)
           
 FxReferenceMetaData<FxPK> FxResultRow.getMetaData(java.lang.String columnName)
           
 

Methods in com.flexive.shared.search with parameters of type FxPK
 FxResultRow FxResultSet.getResultRow(FxPK pk)
          Return a result row wrapper for the given pk, or null if the result row can't be determined.
 FxResultRow FxEmptyResultSet.getResultRow(FxPK pk)
          Return a result row wrapper for the given pk, or null if the result row can't be determined.
 

Uses of FxPK in com.flexive.shared.security
 

Methods in com.flexive.shared.security that return FxPK
 FxPK UserTicket.getContactData()
          Get the primary key for the associated contact data
 FxPK Account.getContactData()
          Get the primary key of the contact data object holding further informations of the user.
 

Uses of FxPK in com.flexive.shared.structure
 

Methods in com.flexive.shared.structure with parameters of type FxPK
 java.lang.String FxType.buildXPathPrefix(FxPK pk)
          Build an XPath prefix for addressing an instance in XPath's
 FxGroupData FxType.createRandomData(FxPK pk, FxEnvironment env, java.util.Random rnd, int maxMultiplicity)
          Create a base group with random data
 

Uses of FxPK in com.flexive.shared.tree
 

Fields in com.flexive.shared.tree declared as FxPK
protected  FxPK FxTreeNode.reference
           
 

Methods in com.flexive.shared.tree that return FxPK
 FxPK FxTreeNode.getReference()
          Get the referenced content
 

Methods in com.flexive.shared.tree with parameters of type FxPK
 FxTreeNodeEdit FxTreeNodeEdit.setReference(FxPK reference)
          Set the referenced content
 

Constructors in com.flexive.shared.tree with parameters of type FxPK
FxTreeNode(FxTreeMode mode, FxLock lock, long id, long parentNodeId, FxPK reference, LifeCycleInfo referenceLifeCycleInfo, long referenceTypeId, java.util.List<java.lang.Long> acls, java.lang.String name, java.lang.String path, FxString label, int position, java.util.List<FxTreeNode> children, java.util.List<java.lang.Long> childIds, int depth, int directChildCount, boolean leaf, boolean dirty, long modifiedAt, java.lang.String data, boolean mayEdit, boolean mayCreate, boolean mayDelete, boolean mayRelate, boolean mayExport)
          Ctor
 

Uses of FxPK in com.flexive.shared.value
 

Subclasses of FxPK in com.flexive.shared.value
 class ReferencedContent
          A referenced content - value class for FxReference
 

Constructors in com.flexive.shared.value with parameters of type FxPK
FxReference(boolean multiLanguage, FxPK value)
          Constructor
FxReference(boolean multiLanguage, long defaultLanguage, FxPK value)
          Constructor
FxReference(FxPK value)
          Constructor
FxReference(long defaultLanguage, FxPK value)
          Constructor
ReferencedContent(FxPK pk)
          Ctor
ReferencedContent(FxPK pk, java.lang.String caption, Step step, java.util.List<ACL> acls)
          Ctor