org.osivia.portal.api.cms

Interface DocumentContext<D extends EcmDocument>

Type Parameters:

D - a type which represents an implementation of ECM Document

All Known Implementing Classes:

AbstractDocumentContext

public interface DocumentContext<D extends EcmDocument>

This class is a root class context for all informations about a CMS document

Author:

Loïc Billon

Method Summary

Modifier and Type	Method and Description
void	addPermissions(Permissions permissions) Add a permisions definition to the collection of permissions
void	addPublicationInfos(PublicationInfos publicationInfos) Add a publication informations definition to the collection of publication informations
Collection<Permissions>	getAllPermissions() Get all classes (with extentions) about permissions on the current document
Collection<PublicationInfos>	getAllPublicationInfos() Get all classes (with extentions) about publication informations on the current document
D	getDoc() Get the document
<P extends Permissions> P	getPermissions(Class<P> permType) Get permissions
<P extends PublicationInfos> P	getPublicationInfos(Class<P> publiInfos) Get publication informations
DocumentType	getType() Get the document type
void	setDoc(D document) Set the document
void	setDocumentType(DocumentType type) Set the document type

Method Detail

getAllPermissions

Collection<Permissions> getAllPermissions()

Get all classes (with extentions) about permissions on the current document

Returns:

all permissions

getPermissions

<P extends Permissions> P getPermissions(Class<P> permType)

Get permissions

Parameters:

permType - the type of permissions

Returns:

permissions

addPermissions

void addPermissions(Permissions permissions)

Add a permisions definition to the collection of permissions

Parameters:

permissions - permissions

getAllPublicationInfos

Collection<PublicationInfos> getAllPublicationInfos()

Get all classes (with extentions) about publication informations on the current document

Returns:

all publication informations

getPublicationInfos

<P extends PublicationInfos> P getPublicationInfos(Class<P> publiInfos)

Get publication informations

Parameters:

publiInfos - the type of publication informations

Returns:

publication informations

addPublicationInfos

void addPublicationInfos(PublicationInfos publicationInfos)

Add a publication informations definition to the collection of publication informations

Parameters:

publication - informations

getType

DocumentType getType()

Get the document type

Returns:

the document type

setDocumentType

void setDocumentType(DocumentType type)

Set the document type

Parameters:

type - the document type

getDoc

D getDoc()

Get the document

Returns:

the document

setDoc

void setDoc(D document)

Set the document

Parameters:

document - the document