org.exoplatform.services.cms.metadata

Interface MetadataService

All Known Implementing Classes:

MetadataServiceImpl

public interface MetadataService

Author : Hung Nguyen Quang nguyenkequanghung@yahoo.com Process with meta data for system

Method Summary

Modifier and Type	Method and Description
String	addMetadata(String nodetype, boolean isDialog, String role, String content, boolean isAddNew) Add new nodetype and set property EXO_ROLES_PROP, EXO_TEMPLATE_FILE_PROP for dialog template node or view template node if node doesn't exist Set property EXO_ROLES_PROP, EXO_TEMPLATE_FILE_PROP for dialog template node or view template node if node exists
String	addMetadata(String nodetype, boolean isDialog, String role, String content, String label, boolean isAddNew) Add new nodetype and set property EXO_ROLES_PROP, EXO_TEMPLATE_FILE_PROP for dialog template node or view template node if node doesn't exist Set property EXO_ROLES_PROP, EXO_TEMPLATE_FILE_PROP for dialog template node or view template node if node exists
List<javax.jcr.nodetype.NodeType>	getAllMetadatasNodeType() Get all NodeType in current repository with NodeType = exo:metadata
List<String>	getExternalMetadataType() Get all NodeType name that contains property that is not autocreated and name of NodeType differs from exo:metadata
javax.jcr.Node	getMetadata(String metaName) Get the metadata node based on its name
String	getMetadataLabel(String metaName) Get metadata label based on its name
List<String>	getMetadataList() Get name of all NodeType in current repository
String	getMetadataPath(String name, boolean isDialog) Get path to dialog template or view tempate node
String	getMetadataRoles(String name, boolean isDialog) Get permission of template node
String	getMetadataTemplate(String name, boolean isDialog) Get content of dialog template node or view template in current repository
boolean	hasMetadata(String name) Check node with given name exists or not below baseMetadataPath_ path in repository
void	init() Call all available in list of TemplatePlugin to add some predefine template to current repository.
void	removeMetadata(String nodetype) Remove node named nodetype below baseMetadataPath_

Method Detail

getMetadataList

List<String> getMetadataList()
                      throws Exception

Get name of all NodeType in current repository

Returns:

ArrayList of name

Throws:

Exception

See Also:

getAllMetadatasNodeType()

getAllMetadatasNodeType

List<javax.jcr.nodetype.NodeType> getAllMetadatasNodeType()
                                                   throws Exception

Get all NodeType in current repository with NodeType = exo:metadata

Returns:

ArrayList of NodeType

Throws:

Exception

addMetadata

String addMetadata(String nodetype,
                   boolean isDialog,
                   String role,
                   String content,
                   boolean isAddNew)
            throws Exception

Add new nodetype and set property EXO_ROLES_PROP, EXO_TEMPLATE_FILE_PROP for dialog template node or view template node if node doesn't exist Set property EXO_ROLES_PROP, EXO_TEMPLATE_FILE_PROP for dialog template node or view template node if node exists

Parameters:

nodetype - Node name for processing

isDialog - true for dialog template

role - permission

content - content of template

isAddNew - false if nodetype exist in repository, true if not

Returns:

path to node if node exist, otherwise return null

Throws:

Exception

addMetadata

String addMetadata(String nodetype,
                   boolean isDialog,
                   String role,
                   String content,
                   String label,
                   boolean isAddNew)
            throws Exception

Add new nodetype and set property EXO_ROLES_PROP, EXO_TEMPLATE_FILE_PROP for dialog template node or view template node if node doesn't exist Set property EXO_ROLES_PROP, EXO_TEMPLATE_FILE_PROP for dialog template node or view template node if node exists

Parameters:

nodetype - Node name for processing

isDialog - true for dialog template

role - permission

content - content of template

label - lable of metadata

isAddNew - false if nodetype exist in repository, true if not

Returns:

path to node if node exist, otherwise return null

Throws:

Exception

removeMetadata

void removeMetadata(String nodetype)
             throws Exception

Remove node named nodetype below baseMetadataPath_

Parameters:

nodetype - name of node

Throws:

Exception

getExternalMetadataType

List<String> getExternalMetadataType()
                              throws Exception

Get all NodeType name that contains property that is not autocreated and name of NodeType differs from exo:metadata

Returns:

ArrayList of metadata type

Throws:

Exception

getMetadataTemplate

String getMetadataTemplate(String name,
                           boolean isDialog)
                    throws Exception

Get content of dialog template node or view template in current repository

Parameters:

name - Node name

isDialog - true: Get dialog template content false: Get view template content

Returns:

content of template

Throws:

Exception

getMetadataPath

String getMetadataPath(String name,
                       boolean isDialog)
                throws Exception

Get path to dialog template or view tempate node

Parameters:

name - Node name

isDialog - true: Get dialog template content false: Get view template content

Returns:

path to template node

Throws:

Exception

getMetadataRoles

String getMetadataRoles(String name,
                        boolean isDialog)
                 throws Exception

Get permission of template node

Parameters:

name - Node name

isDialog - true: Get dialog template content false: Get view template content

Returns:

String of permission

Throws:

Exception

hasMetadata

boolean hasMetadata(String name)
             throws Exception

Check node with given name exists or not below baseMetadataPath_ path in repository

Parameters:

name - Node name

Returns:

true : Exist this node name
false: Not exist this node name

Throws:

Exception

init

void init()
   throws Exception

Call all available in list of TemplatePlugin to add some predefine template to current repository.

Throws:

Exception

getMetadata

javax.jcr.Node getMetadata(String metaName)
                    throws Exception

Get the metadata node based on its name

Parameters:

metaName - Name of metadata

Returns:

Node instance of give metadata

Throws:

Exception

getMetadataLabel

String getMetadataLabel(String metaName)
                 throws Exception

Get metadata label based on its name

Parameters:

metaName - Name of metadata

Returns:

Label of given metadata

Throws:

Exception