Windchill APIs for Queue Management Customizations

Basic Customization > Windchill APIs for Queue Management Customizations

This section contains information on APIs for queue management customizations. Examples of accessing these APIs are given here:

• POM layer classes — Create the object of the class followed by the API call from the object as:

##object.<NameOfAPI>
ProcessingQueue pq = new ProcessingQueue();
pq.addEntry(WTPrincipal princ, String t_method, String t_class, Class[] arg_types, Object[] args);

• Service layer classes — API call from the object is as:

##QueueHelper.manager.<NameOfAPI>
Enumeration em = QueueHelper.manager.queueEntries(ProcessingQueue queue);

APIs Supported Earlier and Not supported now

Class	Signature
ProcessingQueue	public static ProcessingQueue newProcessingQueue( String name ) throws WTException;
ProcessingQueue	public QueueEntry addEntry( WTPrincipal princ, String t_method, String t_class, Class[] arg_types, Object[] args ) throws WTException;
ProcessingQueue	public boolean contains( QueueEntry entry ) throws WTException;
ProcessingQueue	public static ProcessingQueue newProcessingQueue( String name, String host ) throws WTException;
ProcessingQueue	public void addMultiEntry( WTPrincipal princ, String t_method, String t_class, Class[] arg_types, Collection collection ) throws WTException;
ProcessingQueue	protected void initialize( String name ) throws WTException;
ProcessingQueue	protected void initialize( String name, String host ) throws WTException;
ScheduleQueue	public static ScheduleQueue newScheduleQueue( String name ) throws WTException;
ScheduleQueue	public ScheduleQueueEntry addUniqueEntry ( WTPrincipal princ, String t_method, String t_class, Class[] arg_types, Object[] args, Timestamp sched_time ) throws WTException;
ScheduleQueue	public ScheduleQueueEntry addEntry( WTPrincipal princ, String t_method, String t_class, Class[] arg_types, Object[] args, Timestamp sched_time ) throws WTException;
ScheduleQueue	public boolean contains( ScheduleQueueEntry entry ) throws WTException;
ScheduleQueue	public static ScheduleQueue newScheduleQueue( String name, String host ) throws WTException;
ScheduleQueue	public void addMultiEntry( WTPrincipal princ, String t_method, String t_class, Class[] arg_types, Collection collection, Timestamp[] sched_time ) throws WTException;
ScheduleQueue	protected void initialize( String name ) throws WTException;
QueueEntry	public static QueueEntry newQueueEntry( ProcessingQueue queue ) throws WTException;
QueueEntry	protected void initialize( ProcessingQueue queue ) throws WTException;
QueueEntry	public WTPrincipal getPrincipal() throws WTException;
QueueEntry	public void setStatus( String status_code ) throws WTException;
QueueEntry	public String getDisplayString();
ScheduleQueueEntry	public static ScheduleQueueEntry newScheduleQueueEntry( ScheduleQueue queue ) throws WTException;
ScheduleQueueEntry	protected void initialize( ScheduleQueue queue ) throws WTException;
ScheduleQueueEntry	public void setStatus( String status_code ) throws WTException;
ScheduleQueueEntry	public String getDisplayString();
WtQueueEntry	public StatusInfo execute() throws WTException;

APIs which were unsupported earlier and now made supported

Class	Signature
StandardQueueService	public ProcessingQueue getQueue( String queue_name ) throws WTException;
StandardQueueService	public WtQueue getQueue( String queue_name, Class queue_type ) throws WTException;
StandardQueueService	public void deleteEntries( ProcessingQueue queue ) throws WTException;
StandardQueueService	public void deleteEntries( ScheduleQueue queue ) throws WTException;
StandardQueueService	public void deleteEntries( ProcessingQueue queue, String status_code ) throws WTException;
StandardQueueService	public void deleteEntries( ScheduleQueue queue, String status_code ) throws WTException;
StandardQueueService	public Enumeration queueEntries( ProcessingQueue queue ) throws WTException;
StandardQueueService	public Enumeration queueEntries( ScheduleQueue queue ) throws WTException;
StandardQueueService	public Enumeration queueEntries( ProcessingQueue queue, String status_code ) throws WTException;
StandardQueueService	public Enumeration queueEntries( ProcessingQueue queue, Vector status_codes ) throws WTException;
StandardQueueService	public Enumeration queueEntries( ScheduleQueue queue, String status_code ) throws WTException;
StandardQueueService	public void resetQueueEntry( ProcessingQueue queue, String entry_num ) throws WTException;
StandardQueueService	public void resetQueueEntry( ScheduleQueue queue, String entry_num ) throws WTException;
StandardQueueService	public void deleteEntry( QueueInfo qi, QueueEntryInfo qei ) throws WTException;
StandardQueueService	public void deleteEntry(WtQueue queue, WtQueueEntry queueEntry) throws WTException;
StandardQueueService	public WtQueueEntry updateQueueEntry( WtQueue queue, UpdateEntry entryInfo ) throws WTException;
StandardQueueService	public WtQueueEntry updateQueueEntry(WtQueue queue, WtQueueEntry newEntryState) throws WTException;
StandardQueueService	public void deleteEntries(List<? extends Persistable> entries) throws WTException;
StandardQueueService	public Enumeration queueEntries( ScheduleQueue queue, String status_code ) throws WTException;

APIs whose supportability is transferred from object model class to service layer class

The table below lists the APIs whose supportability is transferred from object model class to service layer class. These are the APIs that were supported earlier in object model (POM layer) class but are not supported now.

Class	Signature
StandardQueueService	public QueueEntry addEntry(ProcessingQueue queue, WTPrincipal princ, String t_method, String t_class, Class[] arg_types, Object[] args ) throws WTException;
StandardQueueService	public void addMultiEntry(ProcessingQueue queue, WTPrincipal princ, String t_method, String t_class, Class[] arg_types, Collection collection ) throws WTException;
StandardQueueService	public ScheduleQueueEntry addUniqueEntry (ScheduleQueue queue, WTPrincipal princ, String t_method, String t_class, Class[] arg_types, Object[] args, Timestamp sched_time ) throws WTException;
StandardQueueService	public ScheduleQueueEntry addEntry(ScheduleQueue queue, WTPrincipal princ, String t_method, String t_class, Class[] arg_types, Object[] args, Timestamp sched_time ) throws WTException;
StandardQueueService	public void addMultiEntry(ScheduleQueue queue, WTPrincipal princ, String t_method, String t_class, Class[] arg_types, Collection collection, Timestamp[] sched_time ) throws WTException;
StandardQueueService	public static ProcessingQueue newProcessingQueue( String name ) throws WTException;
StandardQueueService	public static ProcessingQueue newProcessingQueue( String name, String host ) throws WTException;
StandardQueueService	public static ScheduleQueue newScheduleQueue( String name ) throws WTException;
StandardQueueService	public static ScheduleQueue newScheduleQueue( String name, String host ) throws WTException;
StandardQueueService	public boolean contains(WtQueue queue, QueueEntry entry ) throws WTException;
StandardQueueService	public WtQueueEntry execEntry(ProcessingQueue queue, WtQueueEntry entry) throws WTException;
StandardQueueService	public WtQueueEntry execEntry(ScheduleQueue queue, WtQueueEntry entry) throws WTException;
StandardQueueService	public void execEntries(ProcessingQueue queue) throws WTException;
StandardQueueService	public void execEntries(ScheduleQueue queue) throws WTException;
StandardQueueService	public boolean hasItems(ProcessingQueue queue, String[] statuses) throws WTException;
StandardQueueService	public boolean contains(ProcessingQueue queue, QueueEntry entry ) throws WTException;
StandardQueueService	public boolean contains(ScheduleQueue queue, ScheduleQueueEntry entry ) throws WTException;

Isto foi útil?