com.softwareag.centrasite.api.csom.repository
Interface CentraSiteFile

All Superinterfaces:
CentraSiteObject
All Known Subinterfaces:
CentraSiteRepositoryFile, CentraSiteRepositoryFolder, CentraSiteRepositoryObject, ExternalObject

public interface CentraSiteFile
extends CentraSiteObject

CentraSiteFile represents any type of file in CentraSite


Method Summary
 java.lang.String getDescription()
          Returns the file description
 java.lang.String getDisplayURI()
          return the uri which used to display to the user.
 java.lang.String getName()
          Return the file or folder name
 java.lang.String getURI()
          Returns the URI where the file is stored
 boolean isExternal()
          Checks whether the file is stored in repository or otherwise
 void setDescription(java.lang.String description)
          Set the description for the file
 void setName(java.lang.String name)
          Set the name of the file or folder name.
 void setURI(java.lang.String uri)
          Set the repository relative path in case it refers to CentraSiteRepositoryObject other wise external URL.
 
Methods inherited from interface com.softwareag.centrasite.api.csom.CentraSiteObject
delete, getAttributeLink, getAttributeValue, getAttributeValue, getAttributeValue, getId, getType, isModified, isReadOnly, save, setAttributeValue, setAttributeValue, setAttributeValue
 

Method Detail

getURI

java.lang.String getURI()
Returns the URI where the file is stored

Returns:
return the relative URI in case CentraSiteFile refer repository instance other wise url

setURI

void setURI(java.lang.String uri)
            throws CLLException
Set the repository relative path in case it refers to CentraSiteRepositoryObject other wise external URL.

Parameters:
uri - repository relative path in case it refers to CentraSiteRepositoryObject other wise external URL.
Throws:
CLLException

setName

void setName(java.lang.String name)
Set the name of the file or folder name.

Parameters:
name - of the file or folder name.

getName

java.lang.String getName()
Return the file or folder name

Returns:
file or folder name

setDescription

void setDescription(java.lang.String description)
Set the description for the file

Parameters:
description - description for the file.

getDescription

java.lang.String getDescription()
Returns the file description

Returns:
the description set by the user

isExternal

boolean isExternal()
Checks whether the file is stored in repository or otherwise

Returns:
false when the file/folder is pointing to a web dav path, else return true.

getDisplayURI

java.lang.String getDisplayURI()
                               throws CLLException
return the uri which used to display to the user.

Returns:
the display URI which orgnaization id with the orgnaization name.
Throws:
CLLException