All Libraries | This Library | Package | Class | Use | Tree | Deprecated | Index | Grand Index | Help
|  | Foundation |
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

*** This interface provides Binary Compatibility only, not Source Compatibility ***

## com.sas.services.information.metadata.dav
Interface DAVEntityInterface

All Superinterfaces:
  AttributesInterface

All Known Subinterfaces:
  DAVFolderInterface, DAVItemInterface

All Known Implementing Classes:
  DAVApplitem, DAVBinarypackage, DAVEntity, DAVEvent, DAVFolder, DAVItem, DAVPackage, DAVPackageevent, DAVPerson, DAVPersonalrepository, DAVProfile, DAVRemarks, DAVStoredprocessalert

    @SASScope(value="ALL")
    @BinaryCompatibilityOnly
    public interface DAVEntityInterface

extends AttributesInterface

Method Summary
`abstract void` | `addAccessControlEntry(AccessControlEntryInterface ace)` Add an access control entry to the ACL
`abstract DAVEntityInterface` | `copy(DAVFolderInterface folder)` Copy the entity to another folder
`abstract void` | `delete()` Delete the entity
`abstract java.util.List` | `getAccessControlList()`
`abstract java.lang.String` | `getACL()` Get the ACL for this entity
`abstract java.lang.String` | `getCreateDate()` Returns the creation date, if it exists, `null` otherwise
`abstract DAVResource` | `getDAVResource()` Return the underlying DAVResource for this entity, if it exists (that is if it has been fetched)
`abstract java.lang.String` | `getDescription()` Return the entity's description property
`abstract DAVFolderInterface` | `getFolder()` Get the folder that contains this entity
`abstract java.lang.String` | `getGUID()` Return the GUID for this entity, if one has been set.
`abstract java.lang.String` | `getModifyDate()` Returns the last modified date, if it exists, `null` otherwise
`abstract java.lang.String` | `getName()` Get the name of this entity
`abstract java.util.Map` | `getProperties()` Get properties/attributes for this entity
`abstract java.lang.String[]` | `getRemarksKeys()` Get a list of entity keys for the remarks or dicussion threads relating to this object.
`abstract java.util.Map` | `getRemoveUpdates()` If there are any updates to remove properties, then return this list
`abstract java.lang.String` | `getReposId()` Get the repository identifier for this entity.
`abstract RepositoryInterface` | `getRepository()` Get the repository associated with this entity
`abstract java.util.Map` | `getSetUpdates()` If there are any updates to set property values, then return this list
`abstract java.lang.String` | `getType()` Get the entity's object type.
`abstract java.lang.String` | `getUpdateableACL()`
`abstract java.lang.String` | `getUrl()` Get the url for this entity
`abstract java.lang.String` | `getURL()` Return the full url as represented in a repository for this entity
`abstract boolean` | `isCollection()` Is this a collection?
`abstract boolean` | `isDeleted()` Has this entity been deleted?
`abstract boolean` | `isUpdatePending()` Returns whether there are any updates pending for the repository entity
`abstract DAVEntityInterface` | `move(DAVFolderInterface folder)` Move the entity to another folder
`abstract void` | `refresh()` Refresh this entity.
`abstract void` | `refresh(DAVEntityInterface entity)` Refresh this entity from the parameter.
`abstract void` | `removeAccessControlEntry(AccessControlEntryInterface ace)` Remove an access control entry from the ACL
`abstract void` | `setACL(java.lang.String acl)` Set the ACL for this entity
`abstract void` | `setContentClass(java.lang.String contentClass)` Set the contentClass for a paricular resource.
`abstract void` | `setDeleted()` Mark the entity as having been deleted.
`abstract void` | `setDescription(java.lang.String desc)` Set the entity's description property
`abstract void` | `setGUID(java.lang.String guid)` Set the GUID on this entity.
`abstract void` | `setName(java.lang.String name)` Set the name attribute
`abstract void` | `setRemarksKeys(java.lang.String[] remarksKeys)` Set the remarks or discussion threads relating to this object
`abstract void` | `setReposId(java.lang.String reposId)` Set the repository identifier for this entity.
`abstract void` | `update()` Persist any changes to the metadata back to the backing store.

Methods inherited from interface com.sas.services.information.metadata.dav.AttributesInterface
`addAttribute, addAttributes, deleteAttribute, deleteAttributes, getAttribute, getAttributes, setAttribute, setAttributes`

Method Detail

### delete

    void delete()
                throws ServiceException,
                       java.rmi.RemoteException

  Delete the entity

  Throws:
    `ServiceException`
    `java.rmi.RemoteException`

### copy

    DAVEntityInterface copy(DAVFolderInterface folder)

  Copy the entity to another folder

### move

    DAVEntityInterface move(DAVFolderInterface folder)

  Move the entity to another folder

### getUrl

    java.lang.String getUrl()

  Get the url for this entity

  Returns:
    String Returns the Url for this resource

### getReposId

    java.lang.String getReposId()

  Get the repository identifier for this entity. If the repository has not been set, then use the fullurl as an identifier.

  Returns:
    String Entity's repository identifier

### getFolder

    DAVFolderInterface getFolder()

  Get the folder that contains this entity

  Returns:
    DAVFolderInterface

### getName

    java.lang.String getName()

  Get the name of this entity

  Returns:
    String Returns the name of the item/folder

### isCollection

    boolean isCollection()

  Is this a collection?

  Returns:
    boolean Is this resource a collection or not.

### getCreateDate

    java.lang.String getCreateDate()

  Returns the creation date, if it exists, `null` otherwise

  Returns:
    String The creation date

### getModifyDate

    java.lang.String getModifyDate()

  Returns the last modified date, if it exists, `null` otherwise

  Returns:
    String The last modified date

### getRemarksKeys

    java.lang.String[] getRemarksKeys()

  Get a list of entity keys for the remarks or dicussion threads relating to this object.

  Returns:
    String[] An array of entity keys

### setRemarksKeys

    void setRemarksKeys(java.lang.String[] remarksKeys)

  Set the remarks or discussion threads relating to this object

  Parameters:
    `remarksKeys` - An array of entity keys for the remarks relating to this object.

### setACL

    void setACL(java.lang.String acl)

  Set the ACL for this entity

  Parameters:
    `acl` - An XML element string that defines the WebDAV ACL for this resource

### getACL

    java.lang.String getACL()

  Get the ACL for this entity

  Returns:
    String The ACL element that describes the WebDAV ACL for this resource

### getAccessControlList

    java.util.List getAccessControlList()

### refresh

    void refresh()

  Refresh this entity. This means getting a fresh copy from the repository

### update

    void update()
                throws ServiceException,
                       java.rmi.RemoteException

  Persist any changes to the metadata back to the backing store. Build an update list by checking the states of the local variables. Then commit any changes to the store, and get rid of the change list.

  Throws:
    `ServiceException` - in the case of a services failure
    `java.rmi.RemoteException` - in the case of network failures

### getType

    java.lang.String getType()

  Get the entity's object type.

  Returns:
    String Entity's object type

### setReposId

    void setReposId(java.lang.String reposId)

  Set the repository identifier for this entity.

  Parameters:
    `reposId` - Repository identifier for this entity

### getSetUpdates

    java.util.Map getSetUpdates()

  If there are any updates to set property values, then return this list

  Returns:
    Map (of properties to property values) Properties to be set

### getRemoveUpdates

    java.util.Map getRemoveUpdates()

  If there are any updates to remove properties, then return this list

  Returns:
    Map (of properties to null) Properties to be removed

### getURL

    java.lang.String getURL()

  Return the full url as represented in a repository for this entity

  Returns:
    String The url of the entity

### getUpdateableACL

    java.lang.String getUpdateableACL()

### getDAVResource

    DAVResource getDAVResource()

  Return the underlying DAVResource for this entity, if it exists (that is if it has been fetched)

### setContentClass

    void setContentClass(java.lang.String contentClass)

  Set the contentClass for a paricular resource. This will only work once (preferably at object creation time). After that, the contentClass cannot be changed.

  Parameters:
    `contentClass` - The content class to set for this entity

### getProperties

    java.util.Map getProperties()

  Get properties/attributes for this entity

  Returns:
    Map (of properties to values) Entity's properties

### refresh

    void refresh(DAVEntityInterface entity)

  Refresh this entity from the parameter. Reset any pending updates as these don't apply any longer.

  Parameters:
    `entity` - A DAVEntity from which to obtain the latest properties

### setName

    void setName(java.lang.String name)

  Set the name attribute

  Parameters:
    `name` - Value for the name attribute

### getDescription

    java.lang.String getDescription()

  Return the entity's description property

  Returns:
    String The description for the entity

### setDescription

    void setDescription(java.lang.String desc)

  Set the entity's description property

  Parameters:
    `desc` - The value for the description property of the entity

### getRepository

    RepositoryInterface getRepository()

  Get the repository associated with this entity

  Returns:
    RepositoryInterface The repository associated with this entity

### isDeleted

    boolean isDeleted()

  Has this entity been deleted?

  Returns:
    boolean Whether entity has been deleted or not

### setDeleted

    void setDeleted()

  Mark the entity as having been deleted.

### addAccessControlEntry

    void addAccessControlEntry(AccessControlEntryInterface ace)

  Add an access control entry to the ACL

  Parameters:
    `ace` - Access control entry to be added to the ACL

### removeAccessControlEntry

    void removeAccessControlEntry(AccessControlEntryInterface ace)

  Remove an access control entry from the ACL

  Parameters:
    `ace` - Access control entry to be removed from the ACL

### isUpdatePending

    boolean isUpdatePending()

  Returns whether there are any updates pending for the repository entity

  Returns:
    boolean True if there are outstanding updates, false otherwise

### setGUID

    void setGUID(java.lang.String guid)

  Set the GUID on this entity.

  Parameters:
    `guid` - The GUID to be set on this entity

### getGUID

    java.lang.String getGUID()

  Return the GUID for this entity, if one has been set.

  Returns:
    String The GUID for this entity

*** This interface provides Binary Compatibility only, not Source Compatibility ***

All Libraries | This Library | Package | Class | Use | Tree | Deprecated | Index | Grand Index | Help
|  | Foundation |
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2009 SAS Institute Inc. All Rights Reserved.