com.ibm.etools.iseries.perspective.model.util
Class ISeriesNativeMemberBasicUtil

java.lang.Object
  com.ibm.etools.iseries.perspective.model.util.ISeriesNativeMemberBasicUtil

public class ISeriesNativeMemberBasicUtil
extends Object

This is a utility class for dealing with AbstractISeriesNativeMember objects that represent iSeries source members in the iSeries Project Object Model.
Refer to ISeriesModelConstants for the full list of properties.

Field Summary

static String

copyright

Constructor Summary

ISeriesNativeMemberBasicUtil()

Method Summary

static Properties	getDefaultSourceMemberProperties() Returns a Properties object containing the default values for all predefined properties of an iSeries Source Member.
static Properties	getSourceMemberProperties(IQSYSMember member) Returns a Properties object containing the properties of an iSeries Source Member.
static Properties	getSourceMemberProperties(long last_remote_edit_time, String description) Returns a Properties object populated with all the predefined properties of an iSeries Source Member.
static Properties	getSourceMemberProperties(String last_remote_edit_time, String description) Returns a Properties object populated with all the predefined properties of an iSeries Source Member.

Methods inherited from class java.lang.Object

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

Field Detail

copyright

public static final String copyright

See Also:

Constant Field Values

Constructor Detail

ISeriesNativeMemberBasicUtil

public ISeriesNativeMemberBasicUtil()

Method Detail

getDefaultSourceMemberProperties

public static final Properties getDefaultSourceMemberProperties()

Returns a Properties object containing the default values for all predefined properties of an iSeries Source Member. The default values of the properties are the same as the ones used on an iSeries machine. ie:Text description is empty. For the "last remote edit time property", it is simply not set to signal an unknown value.

This method is useful when constructing a properties object that needs default values. Typically use: Properties myMemberProperties = new Properties(getDefaultSourceMemberProperties()); Creates an empty property list with the iSeries defaults.

Returns:

Properties a Properties object containing default values for all the iSeries source member properties.

getSourceMemberProperties

public static final Properties getSourceMemberProperties(IQSYSMember member)

Returns a Properties object containing the properties of an iSeries Source Member. These properties are extracted from the passed ISeriesMember. If any property could not be retrieved, null is returned to signal failure.

Parameters:

member - the source member from which to get the properties.

Returns:

Properties The Properties object containing all the iSeries source member properties. All keys and values are stored as Strings. Returns null if the method fails to retrieve any the of the properties from the ISeriesMember object..

getSourceMemberProperties

public static final Properties getSourceMemberProperties(long last_remote_edit_time,
                                                         String description)

Returns a Properties object populated with all the predefined properties of an iSeries Source Member. The method creates the Properties object and populates it with the correct key/value pairs according to the passed property values.

Parameters:

last_remote_edit_time - if the source member who has the properties represented here has remote equivalent, the "last remote edit time" is the last time this remote instance has been edited.

description - the description for this newly created source member.

Returns:

Properties The Properties list containing all the iSeries source member properties.

getSourceMemberProperties

public static final Properties getSourceMemberProperties(String last_remote_edit_time,
                                                         String description)

Returns a Properties object populated with all the predefined properties of an iSeries Source Member. The method creates the Properties object and populates it with the correct key/value pairs according to the passed property values.

Parameters:

last_remote_edit_time - if the source member who has the properties represented here has remote equivalent, the "last remote edit time" is the last time this remote instance has been edited.

description - the description for this newly created source member.

Returns:

Properties The Properties list containing all the iSeries source member properties.