org.alfresco.wcm.client

Interface DictionaryService

All Known Implementing Classes:

DictionaryServiceImpl

public interface DictionaryService

Dictionary service interface.

Author:

Roy Wetherall

Field Summary

Fields

Modifier and Type	Field and Description
static String	FULL_TYPE_CMIS_DOCUMENT Full CMIS root types
static String	FULL_TYPE_CMIS_FOLDER
static String	TYPE_CMIS_DOCUMENT CMIS root types
static String	TYPE_CMIS_FOLDER
static String	TYPE_PREFIX_DOCUMENT CMIS type prefixes
static String	TYPE_PREFIX_FOLDER

Method Summary

Methods

Modifier and Type	Method and Description
String	getParentType(String type) Gets the parent type of the given type, null if none.
String	getParentType(String type, boolean queryName)
boolean	isDocumentSubType(String type) Indicates whether the given type is a CMIS document type.
boolean	isFolderSubType(String type) Indicates whether the given type is a CMIS document type.
boolean	isRootType(String type) Indicates whether the given type is a root type or not.
String	removeTypePrefix(String type) Removes the type prefix from the type name.

Field Detail

TYPE_CMIS_DOCUMENT

static final String TYPE_CMIS_DOCUMENT

CMIS root types

See Also:

Constant Field Values

TYPE_CMIS_FOLDER

static final String TYPE_CMIS_FOLDER

See Also:

Constant Field Values

TYPE_PREFIX_DOCUMENT

static final String TYPE_PREFIX_DOCUMENT

CMIS type prefixes

See Also:

Constant Field Values

TYPE_PREFIX_FOLDER

static final String TYPE_PREFIX_FOLDER

See Also:

Constant Field Values

FULL_TYPE_CMIS_DOCUMENT

static final String FULL_TYPE_CMIS_DOCUMENT

Full CMIS root types

See Also:

Constant Field Values

FULL_TYPE_CMIS_FOLDER

static final String FULL_TYPE_CMIS_FOLDER

See Also:

Constant Field Values

Method Detail

isRootType

boolean isRootType(String type)

Indicates whether the given type is a root type or not.

Parameters:

type - type

Returns:

boolean true if root type, false otherwise

isDocumentSubType

boolean isDocumentSubType(String type)

Indicates whether the given type is a CMIS document type. Type can be passed as the full string id (eg D:cmis:document) or as the query string value (eg cmis:document).

Parameters:

type - type

Returns:

boolean true if document type, false otherwise

isFolderSubType

boolean isFolderSubType(String type)

Indicates whether the given type is a CMIS document type. Type can be passed as the full string id (eg F:cmis:folder) or as the query string value (eg cmis:folder).

Parameters:

type - type

Returns:

boolean true if folder type, false otherwise

getParentType

String getParentType(String type)

Gets the parent type of the given type, null if none. Type can be passed as the full string id (eg D:cmis:document) or as the query string value (eg cmis:document). By default the type is returned as the full string id

Parameters:

type - type

Returns:

String parent type, null otherwise

getParentType

String getParentType(String type,
                   boolean queryName)

Parameters:

type - type

queryName - returns parent type string as query name if true, otherwise as full id

Returns:

String parent type, null otherwise

See Also:

If queryName is true then the parent type is returned in the format cmis:document, otherwise it is returned in the full id form, D:cmis:document.

removeTypePrefix

String removeTypePrefix(String type)

Removes the type prefix from the type name. Eg D:cmis:document becomes cmis:document. If an non-prefixed name is passed it is unmodified.

Parameters:

type - type name with (or without) type prefix

Returns:

String type name with the prefix striped