Package com.uc4.api
Class SearchResultItem
java.lang.Object
com.uc4.api.SearchResultItem
- All Implemented Interfaces:
ITransportable
This class represents an item from the search result.
-
Constructor Summary
ConstructorsConstructorDescriptionSearchResultItem
(ConnectionAttributes session, Element row) Constructs aSearchResultItem
using the specified XML element. -
Method Summary
Modifier and TypeMethodDescriptionReturns the internal usage id.Returns the folder in which this object can be found.getIcon()
Returns the name of the platform icon if the object type is JOBS.getId()
Returns the date and time of the last modification.getName()
Returns the name of the object.getOpen()
Returns the name of the user who has opened the object.getTitle()
Returns the title of the object.getType()
Deprecated.getUse()
Returns aString
containing information where the object is used.boolean
isLink()
boolean
Returnstrue
if this was a search for use and this match can be replaced.
-
Constructor Details
-
SearchResultItem
Constructs aSearchResultItem
using the specified XML element.- Parameters:
session
- Session time zonerow
- Element
-
-
Method Details
-
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 asUC4Object.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
Returns the internal usage id.- Returns:
- ID
-
isReplaceable
public boolean isReplaceable()Returnstrue
if this was a search for use and this match can be replaced.- Returns:
- true if replace is possible
-
getFolder
Returns the folder in which this object can be found.- Returns:
- Folder of the object
-
getModified
Returns the date and time of the last modification.- Returns:
- Date and time of the last modification
-
getName
Returns the name of the object.- Specified by:
getName
in interfaceITransportable
- Returns:
- Name of the object
-
getOpen
Returns the name of the user who has opened the object.- Returns:
- Name of the user who has opened the object
-
getTitle
Returns the title of the object.- Returns:
- Title of the object
-
getType
Deprecated.UsegetObjectType
instead- Returns:
- Type of the object
-
getUse
Returns aString
containing information where the object is used.- Returns:
- Information where the object is used
-
getId
- Specified by:
getId
in interfaceITransportable
- Returns:
- ID of the object
-
getObjectType
- Specified by:
getObjectType
in interfaceITransportable
- Returns:
- Object type
-
getFolderID
- Specified by:
getFolderID
in interfaceITransportable
- Returns:
- ID of the folder
-
getObjectType
instead