com.sap.scheduler.runtime

Class JobParameterDefinition

java.lang.Object
  com.sap.scheduler.runtime.JobParameterDefinition

All Implemented Interfaces:

Serializable

public class JobParameterDefinition
extends Object
implements Serializable

This class represents the definition for a single job definition parameter.

See Also:

Serialized Form

Constructor Summary

JobParameterDefinition()
Deprecated. Needed for jver tests. Use only the non-empty constructor!

JobParameterDefinition(String name, JobParameterType type, boolean nullable, String description, String dataDefault, boolean display, String direction, String group, HashMap<String,HashMap<String,String>> localizedTextMap)

JobParameterDefinition(String name, JobParameterType type, boolean nullable, String description, String dataDefault, boolean display, String direction, String group, HashMap<String,HashMap<String,String>> localizedTextMap, HashMap<String,String> defaultLocalizedTextMap, String jobDefinitionName, boolean isApplicationInternationalized)

Method Summary

boolean	equals(Object obj)
String	getDefaultData()
HashMap<String,String>	getDefaultLocalizationInfoMap() Returns the default localization info for this parameter.
String	getDescription()
String	getDirection()
String	getGroup()
HashMap<String,HashMap<String,String>>	getLocalizationInfoMap() Returns the localization info for this parameter.
String	getLocalizedDescription() Returns the localized description depending on the system locale The method has different behavior depending on whether the user is provided a default property file (i.e. job-definition.properties).
String	getLocalizedDescription(Locale l) Returns the localized description depending on the provided locale parameter.
String	getLocalizedName() Returns the localized name depending on the system locale The method has different behavior depending on whether the user is provided a default property file (i.e. job-definition.properties).
String	getLocalizedName(Locale l) Returns the localized name depending on the provided locale parameter.
String	getName()
JobParameterType	getType() This method returns the type of the parameter.
int	hashCode()
boolean	isDisplay()
boolean	isIn()
boolean	isInOut()
boolean	isNullable()
boolean	isOut()
void	setDefaultData(String data_default) Deprecated. use constructor instead
void	setDefaultLocalizationInfoMap(HashMap<String,String> defaultLocalizedTextMap) Deprecated. use constructor instead
void	setDescription(String description) Deprecated. use constructor instead
void	setDirection(String direction) Deprecated. use constructor instead
void	setDisplay(boolean display) Deprecated. use constructor instead
void	setGroup(String group) Deprecated. use constructor instead
void	setLocalizationInfoMap(HashMap<String,HashMap<String,String>> localizedTextMap) Deprecated. use constructor instead
void	setName(String name) Deprecated. use constructor instead
void	setNullable(boolean nullable) Deprecated. use constructor instead
void	setType(JobParameterType type) Deprecated. use constructor instead
String	toFormattedString() Returns this JobParameterDefinition in a formatted way

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JobParameterDefinition

public JobParameterDefinition()

Deprecated. Needed for jver tests. Use only the non-empty constructor!

Default constructor

JobParameterDefinition

public JobParameterDefinition(String name,
                              JobParameterType type,
                              boolean nullable,
                              String description,
                              String dataDefault,
                              boolean display,
                              String direction,
                              String group,
                              HashMap<String,HashMap<String,String>> localizedTextMap)

JobParameterDefinition

public JobParameterDefinition(String name,
                              JobParameterType type,
                              boolean nullable,
                              String description,
                              String dataDefault,
                              boolean display,
                              String direction,
                              String group,
                              HashMap<String,HashMap<String,String>> localizedTextMap,
                              HashMap<String,String> defaultLocalizedTextMap,
                              String jobDefinitionName,
                              boolean isApplicationInternationalized)

Method Detail

setLocalizationInfoMap

public void setLocalizationInfoMap(HashMap<String,HashMap<String,String>> localizedTextMap)

Deprecated. use constructor instead

Sets the localization info for this parameter

Parameters:

localizedTextMap - localization info

getLocalizationInfoMap

public HashMap<String,HashMap<String,String>> getLocalizationInfoMap()

Returns the localization info for this parameter.

Note: This method should be used only by the Scheduler runtime.

Returns:

the localization info

getDefaultLocalizationInfoMap

public HashMap<String,String> getDefaultLocalizationInfoMap()

Returns the default localization info for this parameter.

Note: This method should be used only by the Scheduler runtime.

Returns:

the localization info

setDefaultLocalizationInfoMap

public void setDefaultLocalizationInfoMap(HashMap<String,String> defaultLocalizedTextMap)

Deprecated. use constructor instead

Sets the default localization info for this parameter

Parameters:

defaultLocalizedTextMap - localization info

getDefaultData

public String getDefaultData()

Returns:

Returns the default value for this parameter (or null if there is no default)

setDefaultData

public void setDefaultData(String data_default)

Deprecated. use constructor instead

Parameters:

data_default - the default value for this parameter

getDescription

public String getDescription()

Returns:

Returns the description of this parameter to be displayed in a dialog.

setDescription

public void setDescription(String description)

Deprecated. use constructor instead

Set the description for a parameter

Parameters:

description - The description to set.

getDirection

public String getDirection()

Returns:

Returns the direction. It can either be in, out, or inout

isIn

public boolean isIn()

isOut

public boolean isOut()

isInOut

public boolean isInOut()

setDirection

public void setDirection(String direction)

Deprecated. use constructor instead

Parameters:

direction - The direction to set. It can either be in, out, or inout

Throws:

IllegalArgumentException - if the string is not in, out, or inout

isDisplay

public boolean isDisplay()

Returns:

Returns true if this parameter should be displayed in a dialog box, false otherwise.

setDisplay

public void setDisplay(boolean display)

Deprecated. use constructor instead

Parameters:

display - The display to set.

getGroup

public String getGroup()

Returns:

Returns the group.

setGroup

public void setGroup(String group)

Deprecated. use constructor instead

Parameters:

group - The group to set.

getName

public String getName()

Returns:

Returns the name of the parameter.

setName

public void setName(String name)

Deprecated. use constructor instead

Parameters:

name - Set the name of this parameter.

isNullable

public boolean isNullable()

Returns:

Returns true if this parameter may be null, false otherwise

setNullable

public void setNullable(boolean nullable)

Deprecated. use constructor instead

Parameters:

nullable - Set this to true if the parameter may be null, false otherwise

getType

public JobParameterType getType()

This method returns the type of the parameter. The following types are supported:

• String
• Integer
• Long
• Date
• TBD

Returns:

Returns the type.

setType

public void setType(JobParameterType type)

Deprecated. use constructor instead

Sets the type of this parameter.

Parameters:

type - The type to set. See description of getType()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getLocalizedName

public String getLocalizedName()

Returns the localized name depending on the system locale
The method has different behavior depending on whether the user is provided a default property file (i.e. job-definition.properties).

1. If there is no default property file
   Returns the localized name depending on the current system locale. If there is no such file or there is, but without searched key (job..Parameter.), the technical name(e.g. getName()) will be returned.
   
   
2. If there is a default property file
   Returns the localized name in the property file corresponding to the current system locale. If there is no such file or there is, but without the searched key (job..Parameter.), the provided default property file will be used. If there is no such of key, the result should be the key itself.
   
   

Returns:

the localized name depending on the system locale

getLocalizedName

public String getLocalizedName(Locale l)

Returns the localized name depending on the provided locale parameter.
The method has different behavior depending on whether the user is provided a default property file (i.e. job-definition.properties).

1. If there is no default property file
   Returns the localized name depending on the provided locale parameter. If there is no such property file, or there is, but without searched key within (job.) returns the localized name depending on the current system locale. If there is no such file or there is, but without searched key (job..Parameter.), the technical name(e.g. getName()) will be returned.
   
   
2. If there is a default property file
   Returns the localized name in the property file corresponding to the provided system locale. If there is no such file or there is, but without the searched key((job.), returns the localized name depending on the current system locale. If there is no such file or there is, but without searched key (job..Parameter.), the result should be the key itself.
   
   

Parameters:

l - the locale. If it is null, invokes getLocalizedName() for the case when there is no a default property file
and throws NullPointerException when the locale there is a default property file provided (according to the i18n behavior)

Returns:

the localized String if available, otherwise the default name

getLocalizedDescription

public String getLocalizedDescription()

Returns the localized description depending on the system locale
The method has different behavior depending on whether the user is provided a default property file (i.e. job-definition.properties).

1. If there is no default property file
   Returns the localized description depending on the current system locale. If there is no such file or there is, but without searched key (job..Parameter..Description), the technical description(e.g. getDescription()) will be returned.
   
   
2. If there is a default property file
   Returns the localized description in the property file corresponding to the current system locale. If there is no such file or there is, but without the searched key (job..Parameter..Description), the provided default property file will be used. If there is no such of key - the result should be the key itself.

Returns:

the localized description depending on the system locale

getLocalizedDescription

public String getLocalizedDescription(Locale l)

Returns the localized description depending on the provided locale parameter.
The method has different behavior depending on whether the user is provided a default property file (i.e. job-definition.properties).

1. If there is no default property file
   Returns the localized description depending on the provided locale parameter. If there is no such property file or there is, but without searched key within (job..Parameter..Description), returns the localized description depending on the current system locale. If there is no such file or there is, but without searched key (job..Parameter..Description), the technical description (e.g. getDescription()) will be returned.
   
   
2. If there is a default property file
   Returns the localized description in the property file corresponding to the provided system locale. If there is no such file or there is, but without the searched key (job..Parameter..Description), returns the localized description depending on the current system locale. If there is no such file or there is, but without searched key (job..Parameter..Description), the result should be the key itself.
   
   

Parameters:

l - the locale. If it is null, invokes getLocalizedDescription() for the case when there is no a default property file
and throws NullPointerException when the locale there is a default property file provided (according to the i18n behavior)

Returns:

the localized String if available, otherwise the default description

toFormattedString

public String toFormattedString()

Returns this JobParameterDefinition in a formatted way

Returns:

JobParameterDefinition in formatted way

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] ENGFACADE	[sap.com] tc/je/scheduler/api	api	BC-JAS