com.sas.hls.schedule
Class ScheduleDescriptor

java.lang.Object
  extended by com.sas.hls.common.AbstractIdentifiable
      extended by com.sas.hls.schedule.ScheduleDescriptor
All Implemented Interfaces:
Identifiable, Serializable
Direct Known Subclasses:
Schedule

public class ScheduleDescriptor
extends AbstractIdentifiable

A light-weight client representation of a schedule. See Schedule for details.

See Also:
Serialized Form

Nested Class Summary
static class ScheduleDescriptor.ScheduleStatus
          ScheduleStatus is an enum status of a schedule.
 
Field Summary
static String OBJECT_TYPE
           
 
Constructor Summary
ScheduleDescriptor()
          Zero-arg ScheduleDescriptor constructor
ScheduleDescriptor(String scheduleKeyName, String scheduleGroupName)
          Constructor used by the api to populate key values used by the server
 
Method Summary
 boolean equals(Object obj)
           
 String getDescription()
           
 Date getLastModifiedDate()
           
 String getName()
           
 String getOwner()
           
 String getSchedulableLabel()
           
 String getScheduleKeyGroupName()
           
 String getScheduleKeyName()
           
 ScheduleDescriptor.ScheduleStatus getStatus()
           
 void setDescription(String description)
           
 void setLastModifiedDate(Date lastModifiedDate)
           
 void setName(String name)
           
 void setOwner(String owner)
           
 void setSchedulableLabel(String schedulableLabel)
           
 void setStatus(ScheduleDescriptor.ScheduleStatus status)
           
 
Methods inherited from class com.sas.hls.common.AbstractIdentifiable
getIdentifier, getObjectType, hashCode, setIdentifier, setObjectType
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OBJECT_TYPE

public static final String OBJECT_TYPE
See Also:
Constant Field Values
Constructor Detail

ScheduleDescriptor

public ScheduleDescriptor()
Zero-arg ScheduleDescriptor constructor


ScheduleDescriptor

public ScheduleDescriptor(String scheduleKeyName,
                          String scheduleGroupName)
Constructor used by the api to populate key values used by the server

Parameters:
scheduleKeyName - The schedule key name used by the server
scheduleGroupName - he schedule key name used by the server
Method Detail

getStatus

public ScheduleDescriptor.ScheduleStatus getStatus()
Returns:
Returns the status.

setStatus

public void setStatus(ScheduleDescriptor.ScheduleStatus status)
Parameters:
status - The status to set.

getName

public String getName()
Returns:
Returns the name.

setName

public void setName(String name)
Parameters:
name - The name to set.

getDescription

public String getDescription()
Returns:
Returns the description.

setDescription

public void setDescription(String description)
Parameters:
description - The description to set.

getOwner

public String getOwner()
Returns:
Returns the scheduledBy.

setOwner

public void setOwner(String owner)
Parameters:
owner - The owner to set.

getLastModifiedDate

public Date getLastModifiedDate()
Returns:
Returns the lastModifiedDate.

setLastModifiedDate

public void setLastModifiedDate(Date lastModifiedDate)
Parameters:
lastModifiedDate - The lastModifiedDate to set.

getSchedulableLabel

public String getSchedulableLabel()
Returns:
Returns the label of the item you are scheduling.

setSchedulableLabel

public void setSchedulableLabel(String schedulableLabel)
Parameters:
schedulableLabel - Label of the item you are scheduling.

getScheduleKeyName

public String getScheduleKeyName()
Returns:
Returns the scheduleKeyName.

getScheduleKeyGroupName

public String getScheduleKeyGroupName()
Returns:
Returns the scheduleKeyGroupName.

equals

public boolean equals(Object obj)
Overrides:
equals in class AbstractIdentifiable


Copyright (c) 2013, SAS Institute Inc., Cary, NC, USA