Package com.uc4.api

Class SearchResultItem

java.lang.Object
com.uc4.api.SearchResultItem
All Implemented Interfaces:
ITransportable
public class SearchResultItem extends Object implements ITransportable
This class represents an item from the search result.

  • Constructor Details

    • SearchResultItem

      public SearchResultItem(ConnectionAttributes session, Element row)
      Constructs a SearchResultItem using the specified XML element.
      Parameters:
      session - Session time zone
      row - Element

  • Method Details

    • getIcon

      public String getIcon()
      Returns the name of the platform icon if the object type is JOBS. For other object types (JOBP, VARA, ...) only the object type is returned because there is currently no icon in the User Interface. For Jobs the return value is the same as UC4Object.getType()
      Returns:
      Name of the platform icon; possible return values are: JOBS_WINDOWS, JOBS_CIT, JOBP, FILTER, CONN

    • isLink

      public boolean isLink()
      Returns:
      True if the object is only a link

    • getAttributeID

      public String getAttributeID()
      Returns the internal usage id.
      Returns:
      ID

    • isReplaceable

      public boolean isReplaceable()
      Returns true if this was a search for use and this match can be replaced.
      Returns:
      true if replace is possible

    • getFolder

      public String getFolder()
      Returns the folder in which this object can be found.
      Returns:
      Folder of the object

    • getModified

      public DateTime getModified()
      Returns the date and time of the last modification.
      Returns:
      Date and time of the last modification

    • getName

      public String getName()
      Returns the name of the object.
      Specified by:
      getName in interface ITransportable
      Returns:
      Name of the object

    • getOpen

      public String getOpen()
      Returns the name of the user who has opened the object.
      Returns:
      Name of the user who has opened the object

    • getTitle

      public String getTitle()
      Returns the title of the object.
      Returns:
      Title of the object

    • getType

      @Deprecated public String getType()
      Deprecated.
      Use getObjectType instead
      Returns:
      Type of the object

    • getUse

      public String getUse()
      Returns a String containing information where the object is used.
      Returns:
      Information where the object is used

    • getId

      public String getId()
      Specified by:
      getId in interface ITransportable
      Returns:
      ID of the object

    • getObjectType

      public String getObjectType()
      Specified by:
      getObjectType in interface ITransportable
      Returns:
      Object type

    • getFolderID

      public String getFolderID()
      Specified by:
      getFolderID in interface ITransportable
      Returns:
      ID of the folder