com.ibm.jtopenlite.command.program.security
Class RetrieveAuthorizedUsers
- java.lang.Object
-
- com.ibm.jtopenlite.command.program.security.RetrieveAuthorizedUsers
-
-
Field Summary
Fields Modifier and Type Field and Description static java.lang.String
ENDING_PROFILE_LAST
static int
FORMAT_AUTU0100
static int
FORMAT_AUTU0150
static int
FORMAT_AUTU0200
static int
FORMAT_AUTU0250
static java.lang.String
GROUP_NO_GROUP
static java.lang.String
GROUP_NONE
static java.lang.String
SELECTION_ALL
static java.lang.String
SELECTION_GROUP
static java.lang.String
SELECTION_MEMBER
static java.lang.String
SELECTION_USER
static java.lang.String
STARTING_PROFILE_FIRST
-
Constructor Summary
Constructors Constructor and Description RetrieveAuthorizedUsers(int format, int lengthOfReceiverVariable, java.lang.String selectionCriteria, java.lang.String startingProfileName, boolean includeStartingProfile, java.lang.String groupProfileName, java.lang.String endingProfileName)
-
Method Summary
Methods Modifier and Type Method and Description int
getBytesAvailable()
int
getBytesReturned()
int
getFormat()
int
getLengthOfReceiverVariable()
int
getNumberOfParameters()
Returns the number of parameters for this program.int
getNumberOfProfileNames()
byte[]
getParameterInputData(int parmIndex)
Returns the input data of the parameter at the specified index.int
getParameterInputLength(int parmIndex)
Returns the input length of the parameter at the specified index.int
getParameterOutputLength(int parmIndex)
Returns the output length of the parameter at the specified index.int
getParameterType(int parmIndex)
Returns the type of parameter at the specified index.java.lang.String
getProgramLibrary()
Returns the library of the program object.java.lang.String
getProgramName()
Returns the name of the program object.byte[]
getTempDataBuffer()
The implementor can create their own temp byte array for the output parameter size and reuse it each time a call is performed, or for more than one parameter on the same call.void
newCall()
Invoked before any other methods on this interface by CommandConnection whenever this Program is called.void
setFormat(int format)
void
setLengthOfReceiverVariable(int lengthOfReceiverVariable)
void
setListener(RetrieveAuthorizedUsersListener listener)
void
setParameterOutputData(int parmIndex, byte[] data, int maxLength)
Sets the output data for the parameter at the specified index.
-
-
-
Field Detail
-
FORMAT_AUTU0100
public static final int FORMAT_AUTU0100
- See Also:
- Constant Field Values
-
FORMAT_AUTU0150
public static final int FORMAT_AUTU0150
- See Also:
- Constant Field Values
-
FORMAT_AUTU0200
public static final int FORMAT_AUTU0200
- See Also:
- Constant Field Values
-
FORMAT_AUTU0250
public static final int FORMAT_AUTU0250
- See Also:
- Constant Field Values
-
SELECTION_ALL
public static final java.lang.String SELECTION_ALL
- See Also:
- Constant Field Values
-
SELECTION_USER
public static final java.lang.String SELECTION_USER
- See Also:
- Constant Field Values
-
SELECTION_GROUP
public static final java.lang.String SELECTION_GROUP
- See Also:
- Constant Field Values
-
SELECTION_MEMBER
public static final java.lang.String SELECTION_MEMBER
- See Also:
- Constant Field Values
-
STARTING_PROFILE_FIRST
public static final java.lang.String STARTING_PROFILE_FIRST
- See Also:
- Constant Field Values
-
GROUP_NONE
public static final java.lang.String GROUP_NONE
- See Also:
- Constant Field Values
-
GROUP_NO_GROUP
public static final java.lang.String GROUP_NO_GROUP
- See Also:
- Constant Field Values
-
ENDING_PROFILE_LAST
public static final java.lang.String ENDING_PROFILE_LAST
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
RetrieveAuthorizedUsers
public RetrieveAuthorizedUsers(int format, int lengthOfReceiverVariable, java.lang.String selectionCriteria, java.lang.String startingProfileName, boolean includeStartingProfile, java.lang.String groupProfileName, java.lang.String endingProfileName)
-
-
Method Detail
-
getTempDataBuffer
public final byte[] getTempDataBuffer()
Description copied from interface:Program
The implementor can create their own temp byte array for the output parameter size and reuse it each time a call is performed, or for more than one parameter on the same call. The implementor can choose to ignore this, and simply return null. The command connection checks to see if the buffer returned by this method is not null and large enough to accommodate the output parameter size.- Specified by:
getTempDataBuffer
in interfaceProgram
-
getProgramName
public java.lang.String getProgramName()
Description copied from interface:Program
Returns the name of the program object.- Specified by:
getProgramName
in interfaceProgram
-
getProgramLibrary
public java.lang.String getProgramLibrary()
Description copied from interface:Program
Returns the library of the program object.- Specified by:
getProgramLibrary
in interfaceProgram
-
getNumberOfParameters
public int getNumberOfParameters()
Description copied from interface:Program
Returns the number of parameters for this program.- Specified by:
getNumberOfParameters
in interfaceProgram
-
newCall
public void newCall()
Description copied from interface:Program
Invoked before any other methods on this interface by CommandConnection whenever this Program is called.
-
setFormat
public void setFormat(int format)
-
getFormat
public int getFormat()
-
getLengthOfReceiverVariable
public int getLengthOfReceiverVariable()
-
setLengthOfReceiverVariable
public void setLengthOfReceiverVariable(int lengthOfReceiverVariable)
-
getBytesReturned
public int getBytesReturned()
-
getBytesAvailable
public int getBytesAvailable()
-
getNumberOfProfileNames
public int getNumberOfProfileNames()
-
getParameterInputLength
public int getParameterInputLength(int parmIndex)
Description copied from interface:Program
Returns the input length of the parameter at the specified index.- Specified by:
getParameterInputLength
in interfaceProgram
-
getParameterOutputLength
public int getParameterOutputLength(int parmIndex)
Description copied from interface:Program
Returns the output length of the parameter at the specified index.- Specified by:
getParameterOutputLength
in interfaceProgram
-
getParameterType
public int getParameterType(int parmIndex)
Description copied from interface:Program
Returns the type of parameter at the specified index.- Specified by:
getParameterType
in interfaceProgram
- See Also:
Parameter
-
getParameterInputData
public byte[] getParameterInputData(int parmIndex)
Description copied from interface:Program
Returns the input data of the parameter at the specified index.- Specified by:
getParameterInputData
in interfaceProgram
-
setListener
public void setListener(RetrieveAuthorizedUsersListener listener)
-
setParameterOutputData
public void setParameterOutputData(int parmIndex, byte[] data, int maxLength)
Description copied from interface:Program
Sets the output data for the parameter at the specified index.- Specified by:
setParameterOutputData
in interfaceProgram
-
-