Package lumis.portal.bigdata

Interface StandardDocument.Standard.Publication

Enclosing interface:

StandardDocument.Standard

@StableMinor(version="17.0",
             sinceVersion="8.1")
public static interface StandardDocument.Standard.Publication

API that provides access to publications fields.

Since:

8.1.0

Version:

$Revision$ $Date$

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	StandardDocument.Standard.Publication.Context	API that provides access to contexts fields.

Method Summary

Modifier and Type	Method	Description
StandardDocument.Standard.Publication.Context	addContext()	Adds a new contexts field in this publication.
void	addPrincipalIds(java.lang.String... principalIds)	Adds the given principal identifiers to this publication.
void	addPrincipalIds(java.util.Collection<java.lang.String> principalIds)	Adds the given principal identifiers to this publication.
java.util.List<StandardDocument.Standard.Publication.Context>	getContexts()	Returns the access to the fields belonging to the contexts fields in this publication.
java.util.List<java.lang.String>	getPrincipalIds()	Returns the principal identifiers present in this publication.

Method Detail

getPrincipalIds

java.util.List<java.lang.String> getPrincipalIds()

Returns the principal identifiers present in this publication.

Returns:

the principal identifiers present in this publication.

Since:

8.1.0

See Also:

StandardDocumentType.StandardFields.PUBLICATIONS_PRINCIPAL_IDS

addPrincipalIds

void addPrincipalIds(java.lang.String... principalIds)

Adds the given principal identifiers to this publication.

Parameters:

principalIds - the principal identifiers to add.

Since:

8.1.0

See Also:

StandardDocumentType.StandardFields.PUBLICATIONS_PRINCIPAL_IDS

addPrincipalIds

void addPrincipalIds(java.util.Collection<java.lang.String> principalIds)

Adds the given principal identifiers to this publication.

Parameters:

principalIds - the principal identifiers to add.

Since:

8.1.0

See Also:

StandardDocumentType.StandardFields.PUBLICATIONS_PRINCIPAL_IDS

getContexts

java.util.List<StandardDocument.Standard.Publication.Context> getContexts()

Returns the access to the fields belonging to the contexts fields in this publication.

The returned list does not support the set method and its remove method always return null, even when it removes a value.

Returns:

the access to the fields belonging to the contexts fields in this publication.

Since:

8.1.0

See Also:

StandardDocumentType.StandardFields.PUBLICATIONS_CONTEXTS

addContext

StandardDocument.Standard.Publication.Context addContext()

Adds a new contexts field in this publication.

Returns:

the added contexts fields access.

Since:

8.1.0

See Also:

StandardDocumentType.StandardFields.PUBLICATIONS_CONTEXTS