org.osivia.portal.api.cms.impl

Class AbstractDocumentContext<D extends EcmDocument>

java.lang.Object

org.osivia.portal.api.cms.impl.AbstractDocumentContext<D>

Type Parameters:

D - a type which represents an implementation of ECM Document

All Implemented Interfaces:

DocumentContext<D>

public abstract class AbstractDocumentContext<D extends EcmDocument>
extends Object
implements DocumentContext<D>

Abstract implementation of a document context with basic informations (publication, read-write permissions, etc.)

Author:

Loïc Billon

Field Summary

Fields

Modifier and Type	Field and Description
protected D	document document
static String	HIDE_METADATA Hide metadata indicator window property name.

Constructor Summary

Constructors

Constructor and Description
AbstractDocumentContext()

Method Summary

Methods

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
<P extends Permissions> P	getPermissions(Class<P> permType) Get permissions
<P extends PublicationInfos> P	getPublicationInfos(Class<P> navType) Get publication informations
DocumentType	getType() Get the document type
void	setDocumentType(DocumentType type) Set the document type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.osivia.portal.api.cms.DocumentContext

getDoc, setDoc

Field Detail

document

protected D extends EcmDocument document

document

HIDE_METADATA

public static final String HIDE_METADATA

Hide metadata indicator window property name.

See Also:

Constant Field Values

Constructor Detail

AbstractDocumentContext

public AbstractDocumentContext()

Method Detail

getAllPermissions

public Collection<Permissions> getAllPermissions()

Description copied from interface: DocumentContext

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

Specified by:

getAllPermissions in interface DocumentContext<D extends EcmDocument>

Returns:

all permissions

addPermissions

public void addPermissions(Permissions permissions)

Description copied from interface: DocumentContext

Add a permisions definition to the collection of permissions

Specified by:

addPermissions in interface DocumentContext<D extends EcmDocument>

Parameters:

permissions - permissions

getPermissions

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

Description copied from interface: DocumentContext

Get permissions

Specified by:

getPermissions in interface DocumentContext<D extends EcmDocument>

Parameters:

permType - the type of permissions

Returns:

permissions

getAllPublicationInfos

public Collection<PublicationInfos> getAllPublicationInfos()

Description copied from interface: DocumentContext

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

Specified by:

getAllPublicationInfos in interface DocumentContext<D extends EcmDocument>

Returns:

all publication informations

getPublicationInfos

public <P extends PublicationInfos> P getPublicationInfos(Class<P> navType)

Description copied from interface: DocumentContext

Get publication informations

Specified by:

getPublicationInfos in interface DocumentContext<D extends EcmDocument>

Parameters:

navType - the type of publication informations

Returns:

publication informations

addPublicationInfos

public void addPublicationInfos(PublicationInfos publicationInfos)

Description copied from interface: DocumentContext

Add a publication informations definition to the collection of publication informations

Specified by:

addPublicationInfos in interface DocumentContext<D extends EcmDocument>

getType

public DocumentType getType()

Description copied from interface: DocumentContext

Get the document type

Specified by:

getType in interface DocumentContext<D extends EcmDocument>

Returns:

the document type

setDocumentType

public void setDocumentType(DocumentType type)

Description copied from interface: DocumentContext

Set the document type

Specified by:

setDocumentType in interface DocumentContext<D extends EcmDocument>

Parameters:

type - the document type