org.alfresco.service.cmr.remote
Interface AttributeServiceTransport

All Known Implementing Classes:

AttributeServiceTransportService

public interface AttributeServiceTransport

The transport wrapper for remoted AttributeService.

Method Summary

void	addAttribute(java.lang.String ticket, java.util.List keys, Attribute value) Add an attribute to a List Attribute.
void	addAttribute(java.lang.String ticket, java.lang.String path, Attribute value) Add an attribute to a List Attribute
void	addAttributes(java.lang.String ticket, java.util.List keys, java.util.List values) Add a list of attributes.
void	addAttributes(java.lang.String ticket, java.lang.String path, java.util.List values) Add a list of attributes.
boolean	exists(java.lang.String ticket, java.util.List keys) Does an attribute exist.
boolean	exists(java.lang.String ticket, java.lang.String path) Does an attribute exist.
Attribute	getAttribute(java.lang.String ticket, java.util.List keys) Get an attribute.
Attribute	getAttribute(java.lang.String ticket, java.lang.String path) Get an Attribute.
int	getCount(java.lang.String ticket, java.util.List keys) Get the size of a map or list.
int	getCount(java.lang.String ticket, java.lang.String path) Get the size of a map or list.
java.util.List	getKeys(java.lang.String ticket, java.util.List keys) Get all the keys for a give attribute path.
java.util.List	getKeys(java.lang.String ticket, java.lang.String path) Get all the keys for a given attribute path.
java.util.List	query(java.lang.String ticket, java.util.List keys, AttrQuery query) Query for a list of attributes which are contained in a map defined by the given path and meet the query criteria.
java.util.List	query(java.lang.String ticket, java.lang.String path, AttrQuery query) Query for a list of attributes which are contained in the map defined by the given path and meet the query criteria.
void	removeAttribute(java.lang.String ticket, java.util.List keys, int index) Remove an attribute from a list.
void	removeAttribute(java.lang.String ticket, java.util.List keys, java.lang.String name) Remove an Attribute.
void	removeAttribute(java.lang.String ticket, java.lang.String path, int index) Remove an attribute from a list.
void	removeAttribute(java.lang.String ticket, java.lang.String path, java.lang.String name) Remove an Attribute.
void	removeEntries(java.lang.String ticket, java.util.List keys, AttrQuery query) Remove entries from a map that match a query.
void	removeEntries(java.lang.String ticket, java.lang.String path, AttrQuery query) Remove entries from a map that match a query.
void	setAttribute(java.lang.String ticket, java.util.List keys, int index, Attribute value) Set an attribute in a list.
void	setAttribute(java.lang.String ticket, java.util.List keys, java.lang.String name, Attribute value) Set an attribute
void	setAttribute(java.lang.String ticket, java.lang.String path, int index, Attribute value) Set an attribute in a list.
void	setAttribute(java.lang.String ticket, java.lang.String path, java.lang.String name, Attribute value) Set an attribute.
void	setAttributes(java.lang.String ticket, java.util.List keys, java.util.Map entries) Add a set of attributes.
void	setAttributes(java.lang.String ticket, java.lang.String path, java.util.Map entries) Add a set of attributes.

Method Detail

getAttribute

Attribute getAttribute(java.lang.String ticket,
                       java.lang.String path)

Get an Attribute.

Parameters:

ticket - The authentication ticket.

path - The path of the Attribute.

Returns:

The value of the attribute or null.

getAttribute

Attribute getAttribute(java.lang.String ticket,
                       java.util.List keys)

Get an attribute.

Parameters:

ticket - The authentication ticket.

keys - The keys in the attribute path.

Returns:

The value of the attribute or null.

setAttribute

void setAttribute(java.lang.String ticket,
                  java.lang.String path,
                  java.lang.String name,
                  Attribute value)

Set an attribute. Overwrites if it exists.

Parameters:

ticket - The authentication ticket.

name - The name of the Attribute.

value - The value to set.

setAttribute

void setAttribute(java.lang.String ticket,
                  java.util.List keys,
                  java.lang.String name,
                  Attribute value)

Set an attribute

Parameters:

ticket - The authentication ticket.

keys - List of attribute path keys.

name - The name of the attribute to set.

value - The Attribute to set.

setAttribute

void setAttribute(java.lang.String ticket,
                  java.lang.String path,
                  int index,
                  Attribute value)

Set an attribute in a list.

Parameters:

ticket - The authentication ticket.

path - The path to the list.

index - The list index.

value - The Attribute to set.

setAttribute

void setAttribute(java.lang.String ticket,
                  java.util.List keys,
                  int index,
                  Attribute value)

Set an attribute in a list.

Parameters:

ticket - The authentication ticket.

keys - The path components to the list.

index - The list index.

value - The Attribute to set.

addAttribute

void addAttribute(java.lang.String ticket,
                  java.lang.String path,
                  Attribute value)

Add an attribute to a List Attribute

Parameters:

ticket - The authentication ticket.

path - The path to the list.

value - The Attribute to add.

addAttribute

void addAttribute(java.lang.String ticket,
                  java.util.List keys,
                  Attribute value)

Add an attribute to a List Attribute.

Parameters:

ticket - The authentication ticket.

keys - The path components to the list.

value - The Attribute to add.

removeAttribute

void removeAttribute(java.lang.String ticket,
                     java.lang.String path,
                     java.lang.String name)

Remove an Attribute.

Parameters:

ticket - The authentication ticket.

name - The name of the Attribute.

removeAttribute

void removeAttribute(java.lang.String ticket,
                     java.util.List keys,
                     java.lang.String name)

Remove an Attribute.

Parameters:

ticket - The authentication ticket.

keys - List of attribute path keys.

name - The name of the attribute to remove.

removeAttribute

void removeAttribute(java.lang.String ticket,
                     java.lang.String path,
                     int index)

Remove an attribute from a list.

Parameters:

ticket - The authentication ticket.

path - The path to the list.

index - The index to remove.

removeAttribute

void removeAttribute(java.lang.String ticket,
                     java.util.List keys,
                     int index)

Remove an attribute from a list.

Parameters:

ticket - The authentication ticket.

keys - The components of the path to the list.

index - The index to remove.

query

java.util.List query(java.lang.String ticket,
                     java.lang.String path,
                     AttrQuery query)

Query for a list of attributes which are contained in the map defined by the given path and meet the query criteria.

Parameters:

ticket - The authentication ticket.

path -

query -

Returns:

A List of matching attributes.

query

java.util.List query(java.lang.String ticket,
                     java.util.List keys,
                     AttrQuery query)

Query for a list of attributes which are contained in a map defined by the given path and meet the query criteria.

Parameters:

ticket - The authentication ticket.

keys - The list of attribute path keys.

query -

Returns:

A list of matching attributes.

getKeys

java.util.List getKeys(java.lang.String ticket,
                       java.lang.String path)

Get all the keys for a given attribute path.

Parameters:

ticket - The authentication ticket.

path - The attribute path.

Returns:

A list of all keys.

getKeys

java.util.List getKeys(java.lang.String ticket,
                       java.util.List keys)

Get all the keys for a give attribute path.

Parameters:

ticket - The authentication ticket.

keys - The keys of the attribute path.

Returns:

A list of all keys.

getCount

int getCount(java.lang.String ticket,
             java.util.List keys)

Get the size of a map or list.

Parameters:

keys - List of attribute path keys.

Returns:

The size of of the list or map.

getCount

int getCount(java.lang.String ticket,
             java.lang.String path)

Get the size of a map or list.

Parameters:

path - The path to the map or list.

Returns:

The size of the list or map.

exists

boolean exists(java.lang.String ticket,
               java.util.List keys)

Does an attribute exist.

Parameters:

keys - List of attribute path keys.

Returns:

Whether the attribute exists.

exists

boolean exists(java.lang.String ticket,
               java.lang.String path)

Does an attribute exist.

Parameters:

path - The path to the attribute.

Returns:

Whether the attribute exists.

addAttributes

void addAttributes(java.lang.String ticket,
                   java.util.List keys,
                   java.util.List values)

Add a list of attributes.

Parameters:

ticket -

keys -

values -

addAttributes

void addAttributes(java.lang.String ticket,
                   java.lang.String path,
                   java.util.List values)

Add a list of attributes.

Parameters:

ticket -

path -

values -

setAttributes

void setAttributes(java.lang.String ticket,
                   java.util.List keys,
                   java.util.Map entries)

Add a set of attributes.

Parameters:

ticket -

keys -

entries -

setAttributes

void setAttributes(java.lang.String ticket,
                   java.lang.String path,
                   java.util.Map entries)

Add a set of attributes.

Parameters:

ticket -

path -

entries -

removeEntries

void removeEntries(java.lang.String ticket,
                   java.util.List keys,
                   AttrQuery query)

Remove entries from a map that match a query.

Parameters:

ticket -

keys -

query -

removeEntries

void removeEntries(java.lang.String ticket,
                   java.lang.String path,
                   AttrQuery query)

Remove entries from a map that match a query.

Parameters:

ticket -

path -

query -