com.novell.emframe.dev

Class TargetObjects

java.lang.Object

com.novell.emframe.dev.TargetObjects

public class TargetObjects
extends java.lang.Object

This class represents the targets that a task should operate on. It is used by the TargetChooser and is returned by DirUtils.unpackDNs(). It is a wrapper that contains either a single ObjectEntry when there is just one target or an ObjectEntryEnumeration when there are multiple targets. Use isMultiple() to determine if there are more than one targets instead of walking the ObjectEntryEnumeration.

Constructor Summary

Constructors

Constructor and Description
TargetObjects(java.lang.String pack, TaskContext context) Constructs a TargetObjects with the query string used to select objects.

Method Summary

Modifier and Type	Method and Description
static TargetObjects	createInstance(java.lang.String id, TaskContext context)
static boolean	detectPackageAssociation(java.lang.String eDirTarget, TaskContext context, java.lang.StringBuffer packageName) Returns true if a package association is detected on the target object identified by eDir target.
java.lang.String[]	getBadObjectNames() Returns objects found in the directory that did not match the query string.
int	getCount() Returns the length of the target group.
int	getCountReliability() Returns the reliability of the number returned by getCount.
java.lang.String	getCountReliablityMessage() Returns a warning message to display to the user if the count returned is not exact.
java.lang.Exception[]	getErrors() Returns any errors parsing the XML String or finding objects that match the query string.
ObjectEntry	getObjectEntry() Use this method to retrieve the target ObjectEntry only if one target name was specified in the pack parameter in the constructor.
ObjectEntryEnumeration	getObjectEntryEnumeration() Use this method to retrieve the target ObjectEntries if there are multiple targets contained by this object.
ObjectEntry[]	getOEArray() Returns an array of Object Entries for the objects in the target. NOTE: Internal use only.
boolean	isMultiple() Returns true if more than one type name is specified in the constructor or if XML search criteria is provided.
static boolean	isPackageManagedObject(ObjectEntry objectOE, java.lang.StringBuffer packageName) Returns true if a package association is detected on the target object identified by objectOE.
void	reset(TaskContext context) Resets the TargetObjects with a new context and uses the previous query string.
void	setOEArray(ObjectEntry[] OEArray)

Methods inherited from class java.lang.Object

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

Constructor Detail

TargetObjects

public TargetObjects(java.lang.String pack,
                     TaskContext context)
              throws SPIException,
                     PluginException

Constructs a TargetObjects with the query string used to select objects.

Parameters:

pack - String containing XML data which contains the query string used to select the objects

context - TaskContext of the plug-in

Throws:

SPIException

PluginException

Method Detail

createInstance

public static TargetObjects createInstance(java.lang.String id,
                                           TaskContext context)
                                    throws PluginException,
                                           SPIException

Throws:

PluginException

SPIException

reset

public void reset(TaskContext context)
           throws SPIException,
                  org.jdom.JDOMException

Resets the TargetObjects with a new context and uses the previous query string.

Parameters:

context - TaskContext of the plug-in

Throws:

SPIException

org.jdom.JDOMException

getErrors

public java.lang.Exception[] getErrors()

Returns any errors parsing the XML String or finding objects that match the query string.

Returns:

Exception array of errors encountered

getBadObjectNames

public java.lang.String[] getBadObjectNames()

Returns objects found in the directory that did not match the query string.

Returns:

String array of object names

getCount

public int getCount()

Returns the length of the target group. If this is a virtual enumeration, it return -1 (meaning the length is unknown). If this is a virtual enumeration, call getCountReliability to determine the reliability of the count.

Returns:

int containing the length of the target group

See Also:

getCountReliability(), getCountReliablityMessage()

getCountReliability

public int getCountReliability()

Returns the reliability of the number returned by getCount.

Possible values:

• CountableObjectEntryEnumeration.EXACTCOUNT
• CountableObjectEntryEnumeration.APPROXIMATECOUNT
• CountableObjectEntryEnumeration.BASECOUNT
• CountableObjectEntryEnumeration.PARTIALCOUNT
• CountableObjectEntryEnumeration.UNKNOWNCOUNT

Returns:

int containing the reliability of the number returned by getCount

See Also:

CountableObjectEntryEnumeration, getCount(), getCountReliablityMessage()

isMultiple

public boolean isMultiple()

Returns true if more than one type name is specified in the constructor or if XML search criteria is provided. Implies there MAY be more than a single value in the ObjectEntryEnumeration.

Returns:

boolean: false if only a single target name was specified in the constructor, otherwise true. (Note: true does not imply there ARE multiple targets, only that there MAY be multiple targets.)

See Also:

getObjectEntryEnumeration(), getObjectEntry()

getObjectEntryEnumeration

public ObjectEntryEnumeration getObjectEntryEnumeration()

Use this method to retrieve the target ObjectEntries if there are multiple targets contained by this object.

Returns:

An ObjectEntryEnumeration containing the located targets. null if nothing found.

See Also:

isMultiple()

getObjectEntry

public ObjectEntry getObjectEntry()

Use this method to retrieve the target ObjectEntry only if one target name was specified in the pack parameter in the constructor. It returns null in all other cases.

Returns:

An ObjectEntry corresponding to the single name specified in the constructor. null otherwise.

See Also:

isMultiple()

getCountReliablityMessage

public java.lang.String getCountReliablityMessage()

Returns a warning message to display to the user if the count returned is not exact. Returns null if count is exact.

Returns:

String containing message to display about count reliability or null if the count is exact

See Also:

getCount(), getCountReliability()

getOEArray

public ObjectEntry[] getOEArray()

Returns an array of Object Entries for the objects in the target.
NOTE: Internal use only. Added for Group MOO operations, where we need to walk the enumeration more than once. See DGPropertyBook.java This array is only populated when there are multiple objects and they were not obtained with an advanced filter.

setOEArray

public void setOEArray(ObjectEntry[] OEArray)

detectPackageAssociation

public static boolean detectPackageAssociation(java.lang.String eDirTarget,
                                               TaskContext context,
                                               java.lang.StringBuffer packageName)

Returns true if a package association is detected on the target object identified by eDir target. the name of the package will be set in the StringBuffer "packegeName" parameter passed by the calling function

Parameters:

ObjectEntry, - StringBuffer

Returns:

Boolean

isPackageManagedObject

public static boolean isPackageManagedObject(ObjectEntry objectOE,
                                             java.lang.StringBuffer packageName)

Returns true if a package association is detected on the target object identified by objectOE. the name of the package will be set in the StringBuffer "packegeName" parameter passed by the calling function

Parameters:

ObjectEntry, - StringBuffer

Returns:

Boolean