com.citrix.sharefile.api.entities

Class SFMetadataEntity

java.lang.Object

com.citrix.sharefile.api.entities.SFEntitiesBase

com.citrix.sharefile.api.entities.SFMetadataEntity

public class SFMetadataEntity
extends SFEntitiesBase

Field Summary

Fields inherited from class com.citrix.sharefile.api.entities.SFEntitiesBase

client

Constructor Summary

Constructors

Constructor and Description
SFMetadataEntity(ISFApiClient client)

Method Summary

Methods

Modifier and Type	Method and Description
ISFQuery<SFMetadata>	createByItem(java.net.URI url, SFMetadata metadata) Create Metadata { "Name":"metadata name", "Value":"metadata value" } Creates a single Metadata entry that has a specified Name for a given Item.
ISFQuery	delete(java.net.URI url) Delete Metadata Deletes a single Metadata entry that has a specified Name for a given Item.
ISFQuery	deleteByItem(java.net.URI url, java.lang.String metadataId) Delete Metadata Deletes a single Metadata entry that has a specified Name for a given Item.
ISFQuery<SFMetadata>	get(java.net.URI url) Get Metadata by ID Retrieves a single Metadata entry that has a given Name for a given Item.
ISFQuery<SFODataFeed<SFMetadata>>	getByItem(java.net.URI url) Get Metadata List By Item Retrieves the Metadata List for a given Item.
ISFQuery<SFMetadata>	update(java.net.URI url, SFMetadata metadata) Update Metadata { "Value":"metadata value" } Updates a single Metadata entry that has a specified Name for a given Item.
ISFQuery<SFMetadata>	updateByItem(java.net.URI url, java.lang.String metadataId, SFMetadata metadata) Update Metadata { "Value":"metadata value" } Updates a single Metadata entry that has a specified Name for a given Item.

Methods inherited from class com.citrix.sharefile.api.entities.SFEntitiesBase

getEntity

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SFMetadataEntity

public SFMetadataEntity(ISFApiClient client)

Method Detail

get

public ISFQuery<SFMetadata> get(java.net.URI url)
                         throws InvalidOrMissingParameterException

Get Metadata by ID Retrieves a single Metadata entry that has a given Name for a given Item. Note: 'GET https://account.sf-api.com/sf/v3/Items(parentid)/Metadata(id)' is unsupported. Current routing doesn't support the URI to retrieve a single Metadata enntry since it is aliased with the GetByItem feed. So for now we support only the same syntax as for AccessControls, i.e. .../Metadata(name=name,itemid=itemid)

Returns:

A single Metadata object matching the query

Throws:

InvalidOrMissingParameterException

getByItem

public ISFQuery<SFODataFeed<SFMetadata>> getByItem(java.net.URI url)
                                            throws InvalidOrMissingParameterException

Get Metadata List By Item Retrieves the Metadata List for a given Item.

Parameters:

url -

Returns:

The Metadata list of the given object ID.

Throws:

InvalidOrMissingParameterException

createByItem

public ISFQuery<SFMetadata> createByItem(java.net.URI url,
                                SFMetadata metadata)
                                  throws InvalidOrMissingParameterException

Create Metadata { "Name":"metadata name", "Value":"metadata value" } Creates a single Metadata entry that has a specified Name for a given Item. Fails if an entry with the given name already exists for this Item.

Parameters:

url -

Returns:

The created Metadata object

Throws:

InvalidOrMissingParameterException

updateByItem

public ISFQuery<SFMetadata> updateByItem(java.net.URI url,
                                java.lang.String metadataId,
                                SFMetadata metadata)
                                  throws InvalidOrMissingParameterException

Update Metadata { "Value":"metadata value" } Updates a single Metadata entry that has a specified Name for a given Item. Fails if an entry with the given name doesn't exist for this Item.

Parameters:

url -

Returns:

The updated Metadata object

Throws:

InvalidOrMissingParameterException

update

public ISFQuery<SFMetadata> update(java.net.URI url,
                          SFMetadata metadata)
                            throws InvalidOrMissingParameterException

Update Metadata { "Value":"metadata value" } Updates a single Metadata entry that has a specified Name for a given Item. Fails if an entry with the given name doesn't exist for this Item.

Returns:

The updated Metadata object

Throws:

InvalidOrMissingParameterException

deleteByItem

public ISFQuery deleteByItem(java.net.URI url,
                    java.lang.String metadataId)
                      throws InvalidOrMissingParameterException

Delete Metadata Deletes a single Metadata entry that has a specified Name for a given Item. Fails if an entry with the given name doesn't exist for this Item.

Parameters:

url -

Returns:

(no data)

Throws:

InvalidOrMissingParameterException

delete

public ISFQuery delete(java.net.URI url)
                throws InvalidOrMissingParameterException

Delete Metadata Deletes a single Metadata entry that has a specified Name for a given Item. Fails if an entry with the given name doesn't exist for this Item.

Returns:

(no data)

Throws:

InvalidOrMissingParameterException