com.citrix.sdx.nitro.service

Class options

java.lang.Object

com.citrix.sdx.nitro.service.options

public class options
extends Object

options class provides a way to specify additional arguments required while fetching the resource.

Constructor Summary

Constructors

Constructor and Description
options() options class constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	get_action()
boolean	get_compression()
boolean	get_count()
boolean	get_detailview()
String	get_filter()
int	get_pageno()
int	get_pagesize()
void	set_action(String action) sets the action to be performed.
void	set_args(String args) sets args field.
void	set_compression(boolean flag)
void	set_count(boolean flag) sets the count.
void	set_detailview(boolean flag) sets the detail view.
void	set_filter(filtervalue[] filter) sets filter field.
void	set_filter(String filter) sets filter field.
void	set_pageno(int no) sets page number.
void	set_pagesize(int size) sets the pagesize.
String	to_string() constructs a string for options object.

Methods inherited from class java.lang.Object

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

Constructor Detail

options

public options()

options class constructor.

Method Detail

set_pageno

public void set_pageno(int no)

sets page number.

Parameters:

no - page number.

set_pagesize

public void set_pagesize(int size)

sets the pagesize.

Parameters:

size - number of pages to be retrieved.

get_pageno

public int get_pageno()

get_action

public String get_action()

Returns:

action.

set_action

public void set_action(String action)

sets the action to be performed.

Parameters:

action - action.

get_pagesize

public int get_pagesize()

get_compression

public boolean get_compression()

set_compression

public void set_compression(boolean flag)

get_detailview

public boolean get_detailview()

Returns:

detail view.

set_detailview

public void set_detailview(boolean flag)

sets the detail view. if detail view is needed set it to true.

Parameters:

flag -

get_count

public boolean get_count()

Returns:

count.

set_count

public void set_count(boolean flag)

sets the count.

Parameters:

flag - set this to true to find the number of resources of a type configured on NS

set_args

public void set_args(String args)

sets args field.

Parameters:

args - optional args required for any operation. This is in json format.

set_filter

public void set_filter(String filter)

sets filter field.

Parameters:

filter - set this with the filter string to perform filtered get operation on specific type of resource. This is in json format.example: "port:80,servicetype:HTTP".

set_filter

public void set_filter(filtervalue[] filter)

sets filter field.

Parameters:

filter - set this with the filter string to perform filtered get operation. Set the filter parameters in filtervalue object which is then converted to json string.

get_filter

public String get_filter()

Returns:

returns filter.

to_string

public String to_string()

constructs a string for options object.

Returns:

String to be concatenated to the URL.