Package com.uc4.api

Class Template

  • public class Template
extends java.lang.Object
    This class describes a single object template.

    • Field Detail

      • CALE

        public static final Template CALE
        Template for Calendar objects.

      • CALL

        public static final Template CALL
        Template for Notification objects.

      • CALL_STANDARD

        public static final Template CALL_STANDARD
        Template for Notification objects.

      • CALL_MAIL

        public static final Template CALL_MAIL
        Template for Notification objects.

      • CONN_SAP

        public static final Template CONN_SAP
        SAP Connection Object.

      • CONN_SQL

        public static final Template CONN_SQL
        SQL Connection Object.

      • CALL_ALARM

        public static final Template CALL_ALARM
        Template for alarm Notification objects.

      • CODE

        public static final Template CODE
        Template for Code objects.

      • CPIT

        public static final Template CPIT
        Template for Cockpit objects.

      • DOCU

        public static final Template DOCU
        Template for Documentation objects.

      • EVNT_CONS

        public static final Template EVNT_CONS
        Template for Console Events.

      • EVNT_FILE

        public static final Template EVNT_FILE
        Template for File System Events.

      • EVNT_TIME

        public static final Template EVNT_TIME
        Template for Time Events.

      • EVNT_DB

        public static final Template EVNT_DB
        Template for Database Events.

      • FILTER_OUTPUT

        public static final Template FILTER_OUTPUT
        Template for Output Filter.

      • FOLD

        public static final Template FOLD
        Template for Folder.

      • HSTA

        public static final Template HSTA
        Template for Agent/Client Assignment.

      • JOBF

        public static final Template JOBF
        Template for FileTransfer objects.

      • JOBG

        public static final Template JOBG
        Template for Group objects.

      • JOBI

        public static final Template JOBI
        Template for Include objects.

      • JOBP

        public static final Template JOBP
        Template for JobPlan objects.

      • JOBQ_PS_PROCESSREQUEST

        public static final Template JOBQ_PS_PROCESSREQUEST
        Template for PeopleSoft QueueManager objects.

      • JOBQ_R3_ALL_JOBS

        public static final Template JOBQ_R3_ALL_JOBS
        Template for SAP QueueManager objects.

      • JOBQ_R3_INTERCEPTED_JOBS

        public static final Template JOBQ_R3_INTERCEPTED_JOBS
        Template for SAP Intercepted Jobs QueueManager objects.

      • JOBQ_R3_PROCESSCHAINS

        public static final Template JOBQ_R3_PROCESSCHAINS
        Template for SAP ProcessChains QueueManager objects.

      • JOBQ_R3_JAVA_JOBS

        public static final Template JOBQ_R3_JAVA_JOBS
        Template for SAP Java Jobs QueueManager objects.

      • JOBS_BS2000

        public static final Template JOBS_BS2000
        Template for BS2000 Jobs.

      • JOBS_GCOS8

        public static final Template JOBS_GCOS8
        Template for GCOS8 Jobs.

      • JOBS_JMX

        public static final Template JOBS_JMX
        Template for JMX Jobs.

      • JOBS_MPE

        public static final Template JOBS_MPE
        Template for MPE Jobs.

      • JOBS_NSK

        public static final Template JOBS_NSK
        Template for NSK Jobs.

      • JOBS_OA

        public static final Template JOBS_OA
        Template for Oracle Application Jobs.

      • JOBS_OS390

        public static final Template JOBS_OS390
        Template for OS/390 Jobs.

      • JOBS_OS400

        public static final Template JOBS_OS400
        Template for OS/400 Jobs.

      • JOBS_PS

        public static final Template JOBS_PS
        Template for PeopleSoft Jobs.

      • JOBS_R3

        @Deprecated
public static final Template JOBS_R3
        Deprecated.
        Use JOBS_SAP_ABAP, JOBS.SAP_PI or JOBS.SAP_JAVA instead
        Template for SAP Jobs.

      • JOBS_SAP_ABAP

        public static final Template JOBS_SAP_ABAP
        Template for SAP ABAP Jobs.

      • JOBS_SAP_JAVA

        public static final Template JOBS_SAP_JAVA
        Template for SAP Java Jobs.

      • JOBS_SAP_PI

        public static final Template JOBS_SAP_PI
        Template for SAP PI(XI) Jobs.

      • JOBS_SIEBEL

        public static final Template JOBS_SIEBEL
        Template for Siebel Jobs.

      • JOBS_SQL

        public static final Template JOBS_SQL
        Template for SQL Jobs.

      • JOBS_UNIX

        public static final Template JOBS_UNIX
        Template for Unix Jobs.

      • JOBS_VMS

        public static final Template JOBS_VMS
        Template for VMS Jobs.

      • JOBS_WIN

        public static final Template JOBS_WIN
        Template for Windows Jobs.

      • JOBS_GENERIC

        public static final Template JOBS_GENERIC
        Template for Generic Jobs.

      • JSCH

        public static final Template JSCH
        Template for Schedule objects.

      • LOGIN

        public static final Template LOGIN
        Template for Login objects.

      • SCRI

        public static final Template SCRI
        Template for Script objects.

      • STORE

        public static final Template STORE
        Template for Store objects.

      • SYNC

        public static final Template SYNC
        Template for Sync objects.

      • TZ

        public static final Template TZ
        Template for generic Timezone objects.

      • TZ_CET

        public static final Template TZ_CET
        Template for CET Timezone objects.

      • TZ_CST

        public static final Template TZ_CST
        Template for CST Timezone objects.

      • TZ_EST

        public static final Template TZ_EST
        Template for EST Timezone objects.

      • TZ_GMT

        public static final Template TZ_GMT
        Template for GMT Timezone objects.

      • TZ_PST

        public static final Template TZ_PST
        Template for PST Timezone objects.

      • TZ_SYD

        public static final Template TZ_SYD
        Template for SYD Timezone objects.

      • USER

        public static final Template USER
        Template for User objects.

      • USRG

        public static final Template USRG
        Template for Usergroup objects.

      • VARA

        public static final Template VARA
        Template for Variable objects.

      • HOSTG

        public static final Template HOSTG
        Template for AgentGroup objects.

      • XSL

        public static final Template XSL
        Template for Stylesheets.

      • QUEUE

        public static final Template QUEUE
        Template for Queues.

      • CONN_DB

        public static final Template CONN_DB
        Template for Database Connection.

      • PROMPT_SET

        public static final Template PROMPT_SET
        Template PrompSet.

      • VARA_FILELIST

        public static final Template VARA_FILELIST
        Template for Filelist Variable.

      • VARA_MULTI

        public static final Template VARA_MULTI
        Template for Multi Variable.

      • VARA_SQL

        public static final Template VARA_SQL
        Template for SQL Variable.

      • VARA_SQLI

        public static final Template VARA_SQLI
        Template for internal SQL Variable.

      • VARA_SEC_SQL

        public static final Template VARA_SEC_SQL
        Template for secure SQL Variable.

      • VARA_SEC_SQLI

        public static final Template VARA_SEC_SQLI
        Template for secure internal SQL Variable.

      • VARA_BACKEND

        public static final Template VARA_BACKEND
        Template for Backend Variable.

      • VARA_EXEC

        public static final Template VARA_EXEC
        Template for Executable Variable.

      • JOBP_IF

        public static final Template JOBP_IF
        Template for IF workflows.

      • JOBP_FOREACH

        public static final Template JOBP_FOREACH
        Template for FOR EACH workflows.

      • DASH

        public static final Template DASH
        Template for Dashboard objects.

      • VARA_XML

        public static final Template VARA_XML
        Template for XML Variable.

      • PERIOD

        public static final Template PERIOD
        Template for the Period object.

      • SLO

        public static final Template SLO
        Template for the SLO object.

    • Constructor Detail

      • Template

        public Template​(org.w3c.dom.Element row)
        Constructs a Template from the specified Element.
        Parameters:
        row - DOM Element

    • Method Detail

      • getDescription

        public java.lang.String getDescription()
        Returns the description of the template.
        Returns:
        description

      • getIdnr

        public java.lang.String getIdnr()
        Returns the ID of the template.
        Returns:
        ID

      • getTemplateName

        public java.lang.String getTemplateName()
        Returns the name of the template.
        Returns:
        name

      • getType

        public java.lang.String getType()
        Returns the object type of the template.
        Returns:
        type

      • getSubType

        public java.lang.String getSubType()
        Returns the sub-type of the template. If there is no sub-type specified the return value is null.
        Returns:
        subtype or null

      • getPlatform

        public java.lang.String getPlatform()
        Returns the platform of the template. If there is no platform specified the return value is null.
        Returns:
        platform or null

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • isUser

        public boolean isUser()
        Returns true if this template is a template for User objects.
        Returns:
        Boolean which is true if this is a USER template

      • isTimezone

        public boolean isTimezone()
        Returns true if this template is one of the timzone templates.
        Returns:
        Boolean which is true if this is a Timezone template

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • getTemplateFor

        public static Template getTemplateFor​(java.lang.String name)
        Returns the Template for a specified object type null if a matching Template could not be found.
        Parameters:
        name - Object type
        Returns:
        Template instance or null