Package com.axemble.vdoc.sdk.impl

Class PortalFolder

java.lang.Object
com.axemble.vdoc.sdk.impl.AbstractElement
com.axemble.vdoc.sdk.impl.PortalElement
com.axemble.vdoc.sdk.impl.PortalFolder
All Implemented Interfaces:
IElement, IFolder, ILibraryElement, IDeletionSupport, IExternalSupport, IProtocolSupport, ISearchSupport, ISecuritySupport, ITrashSupport, IUriSupport, Serializable
public class PortalFolder extends PortalElement implements IFolder
Author:
vlygeros
See Also:

  • Field Details

    • folder

      protected com.axemble.webdrive.om.FolderNode folder

  • Constructor Details

    • PortalFolder

      protected PortalFolder(IModule module, com.axemble.webdrive.om.FolderNode folder)

  • Method Details

    • getNativeObject

      public Object getNativeObject()
      Description copied from interface: IElement
      Gets the native object underneath.
      Specified by:
      getNativeObject in interface IElement
      Returns:
      an object.

    • getExternalClassName

      public String getExternalClassName()
      Specified by:
      getExternalClassName in interface IExternalSupport

    • getExternalNativeId

      public String getExternalNativeId()
      Specified by:
      getExternalNativeId in interface IExternalSupport

    • getName

      public String getName()
      Description copied from interface: IFolder
      Gets the name of the folder.
      Specified by:
      getName in interface IFolder
      Specified by:
      getName in interface ILibraryElement
      Returns:
      a String object.

    • setName

      public void setName(String name)
      Description copied from interface: IFolder
      Sets the name of the folder.
      Specified by:
      setName in interface IFolder
      Parameters:
      name - the new name to set.

    • getURI

      public String getURI()
      Description copied from interface: IUriSupport
      Gets the URI of the object supporting this interface
      Specified by:
      getURI in interface IUriSupport
      Returns:
      A String object.

    • setDescription

      public void setDescription(String description)
      Description copied from interface: IFolder
      Sets the description of the folder.
      Specified by:
      setDescription in interface IFolder
      Parameters:
      description - the new description to set.

    • getDescription

      public String getDescription()
      Description copied from interface: IFolder
      Gets the description of the folder.
      Specified by:
      getDescription in interface IFolder
      Specified by:
      getDescription in interface ILibraryElement
      Returns:
      a String of the folder.

    • getCreatedDate

      public Date getCreatedDate()
      Description copied from interface: IFolder
      Gets the created date.
      Specified by:
      getCreatedDate in interface IFolder
      Returns:
      a Date object.

    • getModifiedDate

      public Date getModifiedDate()
      Description copied from interface: IFolder
      Gets the modified date.
      Specified by:
      getModifiedDate in interface IFolder
      Returns:
      a Date object.

    • setModifiedDate

      public void setModifiedDate(Date date)
      Description copied from interface: IFolder
      Sets the modified date.
      Specified by:
      setModifiedDate in interface IFolder
      Parameters:
      date - The Date to set.

    • setCreatedBy

      public void setCreatedBy(IUser user)
      Description copied from interface: IFolder
      Sets the creator of the folder.
      Specified by:
      setCreatedBy in interface IFolder
      Parameters:
      user - The user to set as the creator of the folder.

    • getCreatedBy

      public IUser getCreatedBy()
      Description copied from interface: IFolder
      Gets the creator of the folder.
      Specified by:
      getCreatedBy in interface IFolder
      Returns:
      a IUser object.

    • setModifiedBy

      public void setModifiedBy(IUser user)
      Description copied from interface: IFolder
      Sets last user who modified the folder.
      Specified by:
      setModifiedBy in interface IFolder
      Parameters:
      user - The last IUser who modified the folder.

    • getModifiedBy

      public IUser getModifiedBy()
      Description copied from interface: IFolder
      Gets the last user who modified the folder.
      Specified by:
      getModifiedBy in interface IFolder
      Returns:
      a IUser object.

    • addFile

      public void addFile(IFile file)
      Description copied from interface: IFolder
      Adds a IFile object.
      Specified by:
      addFile in interface IFolder
      Parameters:
      file - The IFile object to add.

    • delete

      public void delete(IContext context)
      Description copied from interface: IDeletionSupport
      Deletes the IElement object.
      Specified by:
      delete in interface IDeletionSupport
      Parameters:
      context - The Execution context.

    • getLibrary

      public ILibrary getLibrary()
      Description copied from interface: IFolder
      Gets the library.
      Specified by:
      getLibrary in interface IFolder
      Returns:
      A ILibrary object.

    • getFolders

      public Collection getFolders(IContext context)
      Description copied from interface: IFolder
      Gets the child folders
      Specified by:
      getFolders in interface IFolder
      Parameters:
      context - The execution context.
      Returns:
      A collection of IFolder objects.

    • getFolder

      public IFolder getFolder(IContext context, String name)
      Description copied from interface: IFolder
      Gets a child IFolder object by its name.
      Specified by:
      getFolder in interface IFolder
      Parameters:
      context - The execution context.
      name - The name of the child folder.
      Returns:
      A IFolder object.

    • getParentFolder

      public IFolder getParentFolder()
      Description copied from interface: IFolder
      Gets the parent folder.
      Specified by:
      getParentFolder in interface IFolder
      Returns:
      A IFolder object.

    • isInTrash

      public boolean isInTrash()
      Description copied from interface: ITrashSupport
      Check if the element has been sent to the trash.
      Specified by:
      isInTrash in interface ITrashSupport
      Returns:
      true if yes,
      invalid @link 
      {@link false
      } otherwise.

    • deleteFromTrash

      public void deleteFromTrash()
      Description copied from interface: ITrashSupport
      Delete the element from the trash.
      Specified by:
      deleteFromTrash in interface ITrashSupport

    • restoreFromTrash

      public void restoreFromTrash()
      Description copied from interface: ITrashSupport
      Restore the element from the trash.
      Specified by:
      restoreFromTrash in interface ITrashSupport

    • moveToTrash

      public void moveToTrash()
      Description copied from interface: ITrashSupport
      Move the element to the trash.
      Specified by:
      moveToTrash in interface ITrashSupport