グループ管理メソッド

この記事には、以下のトピックが含まれています。
casm173
この記事には、以下のトピックが含まれています。
このセクションでは、Web サービスのグループ管理メソッドについて説明します。
addMemberToGroup
addMemberToGroup メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
ContactHandle
文字列
メンバとして追加する連絡先のハンドルを示します。
GroupHandle
文字列
連絡先を追加するグループを指定します。
説明
連絡先をグループに追加します。 連絡先がすでにメンバである場合には何も起こりません。
戻り値
なし。
removeMemberFromGroup
MemberFromGroup メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
ContactHandle
文字列
削除する連絡先のハンドルを指定します。
GroupHandle
文字列
連絡先を削除するグループを示します。
説明
グループから連絡先を削除します。 連絡先がメンバではない場合には何も起こりません。
戻り値
なし。
getGroupMemberListValues
getGroupMemberListValues メソッドでは、以下のパラメータを使用します。
パラメータ
タイプ
説明
SID
整数
ログインにより取得したセッションを指定します。
whereClause
文字列
SQL の Where 節を示します。
numToFetch
整数
返されるレコードの最大数を指定します。 ゼロ(0)は指定できません。 「1」を使用するとすべてが返されます。
attributes
String[]
値を取得する属性名の配列を示します。
説明
getListValues() と同じように機能します。ただし、このメソッドではシステムのグループとメンバの関係をクエリします。 システムでは、各グループ/メンバの関係に「グループ メンバ」(grpmem)オブジェクトを使用します。 CA SDM システムでは grpmem オブジェクトはシステムのバックグラウンドで管理されており(ユーザは直接操作しません)、特定のクエリには不可欠なオブジェクトです。
grpmem オブジェクトには 2 つのポインタのみが含まれています。1 つは連絡先を指し、もう 1 つはそれ自体が連絡先オブジェクトであるグループを指しています。 属性名はそれぞれ「member」と「group」です。 これらはポインタであるため、通常通り、ドット表記を使用してクエリを作成する必要があります。 たとえば、「B」で始まる姓を持った、「Seattle」という名前のグループに所属するすべての連絡先を検索するには、以下のように使用します。
member.last_name LIKE 'B%' AND group.last_name = 'Seattle'
以下のように、通常通りハンドルを使用することもできます。
member.last_name LIKE 'A%' AND group.id = U'555A043EDDB36D4F97524F2496B35E75'
このメソッドでは、単一のグループだけでなく、すべてのメンバとグループから値を取得できる点にも注意してください。 特定のグループまたはメンバのすべてのメンバに関する情報を取得するには、Where 節にハンドルを指定します。 たとえば、以下の例では、特定のグループから値を取得します。
group.id = U'555A043EDDB36D4F97524F2496B35E75'
以下の点に注意してください。
  • grpmem オブジェクトにはメンバとグループを指す 2 つのポインタ属性が含まれている。
  • グループ/メンバの関係ごとに grpmem オブジェクトがある。
grpmem メソッドは、実際には grpmem オブジェクト テーブルをクエリし、その結果、2 つの連絡先の関係を表すオブジェクトを返します。 したがって、attributes でフェッチする属性値には、grpmem オブジェクトのドット表記を使用する必要があります。 メンバから値をフェッチするには、すべての属性名を以下のように「member.
ATTRNAME
」形式にする必要があります。
'member.last_name'
グループから値をフェッチするには、「group.
ATTRNAME
」を使用します。
グループやメンバの効率的なクエリの例については、「Where 節」を参照してください。
戻り値
自動的に空のハンドルが返されます。 戻り値の <Handle> エレメントは常に空です。 行ごとにメンバまたはグループのハンドルをリクエストするには、表で説明されている attributes パラメータで以下のいずれかを使用します。
  • "member.persistent_id"
  • "group.persistent_id"
XML エレメント
タイプ
説明
<UDSObjectList>
N/A
一連の <UDSObject> エレメントを含む外部エレメントを示します。 各オブジェクトは grpmem オブジェクトです。