| com.flexive.shared.interfaces.ContentEngine
All known Subclasses: com.flexive.ejb.beans.ContentEngineBean,
ContentEngine | public interface ContentEngine (Code) | | ContentEngine
author: Markus Plesser (markus.plesser@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at) |
getBinaryId | long getBinaryId(FxPK pk, String xpath, FxLanguage language) throws FxApplicationException(Code) | | Get the binary id for the given XPath.
The root ("/") XPath will return the contents preview binary id.
An invalid XPath or no associated binary id will throw an FxNotFoundException or
FxInvalidParameterException.
Security will be checked and FxNoAccessException thrown if restricted.
Parameters: pk - primary key Parameters: xpath - XPath Parameters: language - the language (if null, the user ticket language will be used) binary id throws: FxApplicationException - on errors |
getPKsForType | List<FxPK> getPKsForType(long typeId, boolean onePkPerInstance) throws FxApplicationException(Code) | |
Returns all primary keys for the given type. Since this method does not implement security,
it may only be called by the global supervisor. You can use the search engine to achieve
the same, just with security enabled, with
final List<FxPK> folderPks = new SqlQueryBuilder().select("@pk").type("FOLDER").getResult().collectColumn(1);
Parameters: typeId - the type to request the primary keys for Parameters: onePkPerInstance - return one primary key per instance (with max version) or one per actual version? list containing the primary keys throws: FxApplicationException - on errors |
getReferencedContentCount | int getReferencedContentCount(FxPK pk) throws FxApplicationException(Code) | | Get the number of references that exist for the requested content
Parameters: pk - primary key of the requested content number of references that exist for the requested content throws: FxApplicationException - on errors |
initialize | FxContent initialize(long typeId, long mandatorId, long prefACL, long prefStep, long prefLang) throws FxApplicationException(Code) | | Initialize a new FxContent instance with preferred acl, step and language
Parameters: typeId - type to use Parameters: mandatorId - mandator to assign this content (has to be available for the type!) Parameters: prefACL - preferred acl, if not applicable the best fit will be used Parameters: prefStep - preferred step, if not applicable the best fit will be used Parameters: prefLang - preferred language, if not applicable the best fit will be used FxContent throws: FxApplicationException - TODO throws: FxLoadException - on initialization errors |
initialize | FxContent initialize(long typeId) throws FxApplicationException(Code) | | Initialize a new FxContent instance for a type with default values.
mandator, ACL, Step and Lang will be taken on a "first-useable" basis
Parameters: typeId - type to use content instance throws: FxApplicationException - on errors |
prepareSave | FxContent prepareSave(FxContent content) throws FxApplicationException(Code) | | Prepare a content for a save or create operation (resolves binaries for script processing, etc.).
This is optional and is not required to be called prior to saving, it exists to have
metadata available in GUI's prior to saving.
Parameters: content - the content to prepare the prepared content throws: FxInvalidParameterException - on errors throws: FxDbException - on errors |
|
|