AdminCommonOptions (KonaKartAdmin API Documentation)

java.lang.Object
- com.konakartadmin.app.AdminCommonOptions

public class AdminCommonOptions
extends java.lang.Object

Generic options object for the Admin APIs.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.lang.String`	`custom1` custom1 - use depends on the API call
`private int`	`custom1Rule` custom1 Rule - use depends on the API call
`private java.lang.String`	`custom2` custom2 - use depends on the API call
`private int`	`custom2Rule` custom2 Rule - use depends on the API call
`private int`	`id` Id - use depends on the API call
`private int`	`id2` Id2 - use depends on the API call
`private int`	`id3` Id3 - use depends on the API call
`private int`	`id4` Id24 - use depends on the API call
`private int[]`	`ids` Ids - use depends on the API call
`private boolean`	`includeChildren` includeChildren - use depends on the API call
`private int`	`languageId` languageId - use depends on the API call
`private java.lang.String`	`name` Name - use depends on the API call
`private int`	`nameRule` Name Rule - use depends on the API call
`private java.lang.String`	`orderBy` orderBy - use depends on the API call

Constructor Summary

Constructors
Constructor and Description

AdminCommonOptions()
Instantiates an AdminCommonOptions object - a requirement for a bean class

Constructors
Constructor and Description
`AdminCommonOptions()` Instantiates an AdminCommonOptions object - a requirement for a bean class

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCustom1()`
`int`	`getCustom1Rule()` The usage is dependent on the API call.
`java.lang.String`	`getCustom2()`
`int`	`getCustom2Rule()` The usage is dependent on the API call.
`int`	`getId()`
`int`	`getId2()`
`int`	`getId3()`
`int`	`getId4()`
`int[]`	`getIds()`
`int`	`getLanguageId()`
`java.lang.String`	`getName()`
`int`	`getNameRule()` The usage is dependent on the API call.
`java.lang.String`	`getOrderBy()`
`boolean`	`isIncludeChildren()`
`void`	`setCustom1(java.lang.String custom1)`
`void`	`setCustom1Rule(int custom1Rule)` The usage is dependent on the API call.
`void`	`setCustom2(java.lang.String custom2)`
`void`	`setCustom2Rule(int custom2Rule)` The usage is dependent on the API call.
`void`	`setId(int id)`
`void`	`setId2(int id2)`
`void`	`setId3(int id3)`
`void`	`setId4(int id4)`
`void`	`setIds(int[] ids)`
`void`	`setIncludeChildren(boolean includeChildren)`
`void`	`setLanguageId(int languageId)`
`void`	`setName(java.lang.String name)`
`void`	`setNameRule(int nameRule)` The usage is dependent on the API call.
`void`	`setOrderBy(java.lang.String orderBy)`
`java.lang.String`	`toString()`
`java.lang.String`	`toStringBrief()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ids
```
private int[] ids
```
    Ids - use depends on the API call
  - id
```
private int id
```
    Id - use depends on the API call
  - id2
```
private int id2
```
    Id2 - use depends on the API call
  - id3
```
private int id3
```
    Id3 - use depends on the API call
  - id4
```
private int id4
```
    Id24 - use depends on the API call
  - name
```
private java.lang.String name
```
    Name - use depends on the API call
  - nameRule
```
private int nameRule
```
    Name Rule - use depends on the API call
  - custom1
```
private java.lang.String custom1
```
    custom1 - use depends on the API call
  - custom1Rule
```
private int custom1Rule
```
    custom1 Rule - use depends on the API call
  - custom2
```
private java.lang.String custom2
```
    custom2 - use depends on the API call
  - custom2Rule
```
private int custom2Rule
```
    custom2 Rule - use depends on the API call
  - includeChildren
```
private boolean includeChildren
```
    includeChildren - use depends on the API call
  - languageId
```
private int languageId
```
    languageId - use depends on the API call
  - orderBy
```
private java.lang.String orderBy
```
    orderBy - use depends on the API call
- Constructor Detail
  - AdminCommonOptions
```
public AdminCommonOptions()
```
    Instantiates an AdminCommonOptions object - a requirement for a bean class
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    Returns a string containing the attributes of the AdminSearch object.
  - toStringBrief
```
public java.lang.String toStringBrief()
```
    Returns:
    
    Returns a string containing a few of the attributes of the AdminCommonOptions object.
  - getOrderBy
```
public java.lang.String getOrderBy()
```
    Returns:
    
    Returns the orderBy.
  - setOrderBy
```
public void setOrderBy(java.lang.String orderBy)
```
    Parameters:
    orderBy - The orderBy to set. The usage is dependent on the API call. Examples are:
    
    AdminSearch.ORDER_BY_ID_ASCENDING
    
    AdminSearch.ORDER_BY_ID_DESCENDING
    
    AdminSearch.ORDER_BY_NAME_ASCENDING
    
    AdminSearch.ORDER_BY_NAME_DESCENDING
    
    AdminSearch.ORDER_BY_DESCRIPTION_ASCENDING
    
    AdminSearch.ORDER_BY_DESCRIPTION_DESCENDING
    
    AdminSearch.ORDER_BY_SORT_ORDER_DESCENDING
    
    AdminSearch.ORDER_BY_SORT_ORDER_DESCENDING
  - getName
```
public java.lang.String getName()
```
    Returns:
    
    the Name
  - setName
```
public void setName(java.lang.String name)
```
    Parameters:
    
    name - the name. The usage is dependent on the API call.
  - getLanguageId
```
public int getLanguageId()
```
    Returns:
    
    the languageId
  - setLanguageId
```
public void setLanguageId(int languageId)
```
    Parameters:
    
    languageId - languageId to set. Set to -1 for the default language and to 0 for all languages. . The usage is dependent on the API call.
  - getId
```
public int getId()
```
    Returns:
    
    the Id
  - setId
```
public void setId(int id)
```
    Parameters:
    
    id - the Id to set. The usage is dependent on the API call.
  - isIncludeChildren
```
public boolean isIncludeChildren()
```
    Returns:
    
    Returns the includeChildren.
  - setIncludeChildren
```
public void setIncludeChildren(boolean includeChildren)
```
    Parameters:
    
    includeChildren - The includeChildren to set. The usage is dependent on the API call.
  - getId2
```
public int getId2()
```
    Returns:
    
    the id2
  - setId2
```
public void setId2(int id2)
```
    Parameters:
    
    id2 - the id2 to set. The usage is dependent on the API call.
  - getNameRule
```
public int getNameRule()
```
    The usage is dependent on the API call. Typical values are:
    - KKConstants.SEARCH_EXACT
    - KKConstants.SEARCH_ADD_WILDCARD_BEFORE
    - KKConstants.SEARCH_ADD_WILDCARD_AFTER
    - KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Returns:
    
    the nameRule
  - setNameRule
```
public void setNameRule(int nameRule)
```
    The usage is dependent on the API call. Typical values are:
    - KKConstants.SEARCH_EXACT
    - KKConstants.SEARCH_ADD_WILDCARD_BEFORE
    - KKConstants.SEARCH_ADD_WILDCARD_AFTER
    - KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Parameters:
    
    nameRule - the nameRule to set. The usage is dependent on the API call.
  - getId3
```
public int getId3()
```
    Returns:
    
    the id3
  - setId3
```
public void setId3(int id3)
```
    Parameters:
    
    id3 - the id3 to set. The usage is dependent on the API call.
  - getId4
```
public int getId4()
```
    Returns:
    
    the id4
  - setId4
```
public void setId4(int id4)
```
    Parameters:
    
    id4 - the id4 to set. The usage is dependent on the API call.
  - getIds
```
public int[] getIds()
```
    Returns:
    
    the ids
  - setIds
```
public void setIds(int[] ids)
```
    Parameters:
    
    ids - the ids to set. The usage is dependent on the API call.
  - getCustom1
```
public java.lang.String getCustom1()
```
    Returns:
    
    the custom1
  - setCustom1
```
public void setCustom1(java.lang.String custom1)
```
    Parameters:
    
    custom1 - the custom1 to set. The usage is dependent on the API call.
  - getCustom1Rule
```
public int getCustom1Rule()
```
    The usage is dependent on the API call. Typical values are:
    - KKConstants.SEARCH_EXACT
    - KKConstants.SEARCH_ADD_WILDCARD_BEFORE
    - KKConstants.SEARCH_ADD_WILDCARD_AFTER
    - KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Returns:
    
    the custom1Rule
  - setCustom1Rule
```
public void setCustom1Rule(int custom1Rule)
```
    The usage is dependent on the API call. Typical values are:
    - KKConstants.SEARCH_EXACT
    - KKConstants.SEARCH_ADD_WILDCARD_BEFORE
    - KKConstants.SEARCH_ADD_WILDCARD_AFTER
    - KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Parameters:
    
    custom1Rule - the custom1Rule to set. The usage is dependent on the API call.
  - getCustom2
```
public java.lang.String getCustom2()
```
    Returns:
    
    the custom2
  - setCustom2
```
public void setCustom2(java.lang.String custom2)
```
    Parameters:
    
    custom2 - the custom2 to set. The usage is dependent on the API call.
  - getCustom2Rule
```
public int getCustom2Rule()
```
    The usage is dependent on the API call. Typical values are:
    - KKConstants.SEARCH_EXACT
    - KKConstants.SEARCH_ADD_WILDCARD_BEFORE
    - KKConstants.SEARCH_ADD_WILDCARD_AFTER
    - KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Returns:
    
    the custom1Rule
  - setCustom2Rule
```
public void setCustom2Rule(int custom2Rule)
```
    The usage is dependent on the API call. Typical values are:
    - KKConstants.SEARCH_EXACT
    - KKConstants.SEARCH_ADD_WILDCARD_BEFORE
    - KKConstants.SEARCH_ADD_WILDCARD_AFTER
    - KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Parameters:
    
    custom2Rule - the custom2Rule to set. The usage is dependent on the API call.

Class AdminCommonOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ids

id

id2

id3

id4

name

nameRule

custom1

custom1Rule

custom2

custom2Rule

includeChildren

languageId

orderBy

Constructor Detail

AdminCommonOptions

Method Detail

toString

toStringBrief

getOrderBy

setOrderBy

getName

setName

getLanguageId

setLanguageId

getId

setId

isIncludeChildren

setIncludeChildren

getId2

setId2

getNameRule

setNameRule

getId3

setId3

getId4

setId4

getIds

setIds

getCustom1

setCustom1

getCustom1Rule

setCustom1Rule

getCustom2

setCustom2

getCustom2Rule

setCustom2Rule