curam.core.sl.infrastructure.cmis.impl

Interface CMSMetadataInterface

All Known Implementing Classes:

CMSMetadataImpl

@AccessLevel(value=EXTERNAL)
public interface CMSMetadataInterface

This interface provides a wrapper for CMS meta data. It allows any code to update the transaction scoped meta data which may eventually be used by the next CMS create or modify operation. This should never be implemented. Please extend CMSMetadataImpl instead.

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String name, curam.util.type.Date value) Store the meta data property and it's date value.
void	add(java.lang.String name, java.lang.String value) Store the meta data property and it's value.
boolean	clear(java.lang.String name) Clear the meta data property.
void	clearAll() Clear all the meta data.
boolean	contains(java.lang.String name) Determines whether the meta data property is already included.
java.lang.String	get(java.lang.String name) Read the value of the meta data property.
java.util.Iterator<curam.core.sl.struct.CMSMetadataItem>	iterator() Return an iterator for all the meta data properties provided.

Method Detail

add

void add(java.lang.String name,
         java.lang.String value)

Store the meta data property and it's value.

Parameters:

name - The name of the meta data property.

value - The value of the meta data property.

get

java.lang.String get(java.lang.String name)

Read the value of the meta data property.

Parameters:

name - The name of the meta data property.

Returns:

the value of the meta data property.

add

void add(java.lang.String name,
         curam.util.type.Date value)

Store the meta data property and it's date value.

Parameters:

name - The name of the meta data property.

value - The value of the meta data date property.

iterator

java.util.Iterator<curam.core.sl.struct.CMSMetadataItem> iterator()

Return an iterator for all the meta data properties provided.

Returns:

the iterator for all the meta data properties provided.

contains

boolean contains(java.lang.String name)

Determines whether the meta data property is already included.

Parameters:

name - The name of the meta data property.

Returns:

true if the property is already included, false otherwise.

clear

boolean clear(java.lang.String name)

Clear the meta data property.

Parameters:

name - The name of the meta data property.

Returns:

true if the property has been removed, false if it doesn't exist.

clearAll

void clearAll()

Clear all the meta data.