DocumentMetadata

From LogicalDOC Community Wiki

Contents 1 WSTemplate[] listTemplates(String sid) 2 WSTemplate getTemplate(String sid, String name) 3 long storeTemplate(String sid, WSTemplate template) 4 void deleteTemplate(String sid, long templateId)

This webservice allows the administration of metadata related issues.

WSTemplate[] listTemplates(String sid)

Gets template metadata of all existing templates.

Parameters

• sid - The session identifier

Returns

• array of WSTemplate

Throws

• Exception - If there is any error during the operation.

WSTemplate getTemplate(String sid, String name)

Gets template metadata.

Parameters

• sid - The session identifier
• name - The template name

Returns

• the found WSTemplate

Throws

• Exception - If there is any error during the operation.

long storeTemplate(String sid, WSTemplate template)

Create/Update a template. You can completely customize the template through a value object containing the template's metadata.

Parameters

• sid - The session identifier, must be an administrator
• template - The template to be stored

Returns

• The template identifier

Throws

• Exception - If there is any error updateing the record

void deleteTemplate(String sid, long templateId)

Deletes an existing template with the given identifier.

Parameters

• sid - The session identifier, must be an administrator
• templateId - The template to be deleted

Returns

• Nothing

Throws

• Exception - If there is any error