Package wt.inf.sharing

Interface DataSharingService

@RemoteInterface
public interface DataSharingService

Client accessible data sharing API. Include methods to create, query and manipulate information about shared data.

Supported API: true

Extendable: false

Method Summary

Modifier and Type	Method	Description
void	removeShare(Persistable object, WTContainerRef container_ref)	Removes all {@link wt,inf.sharing.SharedContainerMap} for the target object and target container pased as arguments.
void	removeShare(SharedContainerMap map)	Removes all {@link wt,inf.sharing.SharedContainerMap} with the same key and target container as the one passed as argument.
SharedContainerMap	shareVersion(Persistable object, WTContainerRef to_container_ref, Folder to_folder)	Shares an object given the target container and the target folder.
WTCollection	shareVersions(WTCollection objects, WTContainerRef to_container_ref, Folder to_folder)	Shares a WTCollection given the target container and the target folder.

Method Details

removeShare

void removeShare(SharedContainerMap map)
          throws WTException

Removes all {@link wt,inf.sharing.SharedContainerMap} with the same key and target container as the one passed as argument.

Supported API: true

Parameters:

map -

Throws:

WTException

removeShare

void removeShare(Persistable object,
 WTContainerRef container_ref)
          throws WTException

Removes all {@link wt,inf.sharing.SharedContainerMap} for the target object and target container pased as arguments. Removes both object and version shares, enabled or disabled shares.

NoteIf the share exists and is a COLLECTIVE, FOLDER or STRUCTURE share, then all related shares are removed.

Supported API: true

Parameters:

object -

container_ref -

Throws:

WTException

shareVersion

SharedContainerMap shareVersion(Persistable object,
 WTContainerRef to_container_ref,
 Folder to_folder)
                         throws WTException

Shares an object given the target container and the target folder. If the object is Iterated, then a version is shared, otherwise an instance is shared. Returns a wt.inf.SharedContainerMap object representing the sharing of the data.

The way the operation deals with duplicate shares is as follows:

• If there is an equivalent version share, nothing happens and the equivalent share is returned;
• If there is a conflicting share, then it is deleted and a new share is created.
• If there is no conflicting share: a new share is created.

Where an equivalent share is one with same target object and container: same ûmodeú (version/object); same target folder. A conflicting share is one with same target object and container but has either a different mode or a different folder.

Supported API: true

Parameters:

object -

to_container_ref -

to_folder -

Returns:

SharedContainerMap

Throws:

WTException

See Also:

• Iterated
• WTContainer
• Folder
• wt.sharing.SharedContainerMap

shareVersions

WTCollection shareVersions(WTCollection objects,
 WTContainerRef to_container_ref,
 Folder to_folder)
                    throws WTException

Shares a WTCollection given the target container and the target folder. Returns a collection of SharedContainerMap representing the sharing of the objects. The objects in the input collection are not assumed to be Iterated. For the ones that are version shares are created; for the others, object shares. The shares are not assumed to belong to the same action. This means that they can be removed/disabled/enabled independently.

Supported API: true

Parameters:

objects -

to_container_ref -

to_folder -

Returns:

WTCollection

Throws:

WTException