Package classes

Class Object_Collection

java.lang.Object

classes.Object_BaseObject

classes.Object_Collection

All Implemented Interfaces:

android.os.Parcelable

public class Object_Collection
extends Object_BaseObject

A collection is a selection of Object_Product, organized into one or more Object_Collection.Object_CollectionGroup. For example, a collection can represent an inventory for a store or just a subset of products, such as selection of products that are currently on sale or a selection of private-label products.

In general, a collection will be an Object_Collection.Other_CollectionType.INVENTORY or an Object_Collection.Other_CollectionType.EVENT. Events are temporal in nature, such as a tasting events or weekly promotions. Inventories, whether entire inventories or subsets of an inventory, are meant to change from time to time but are not specifically temporal in nature.

A Collection may also be a Object_Collection.Other_CollectionType.CELLAR type (e.g., a Object_Customer's personal cellar) or Object_Collection.Other_CollectionType.OTHER type.

Collections are structured as follows: a collection has one or more Object_Collection.Object_CollectionVersions. Each version has one or more Object_Collection.Object_CollectionGroups. And each group contains one or more Object_Collection.Object_CollectionOrders, which link directly to a Object_Tag and thus by reference a Object_Product.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Object_Collection.Object_CollectionGroup	Products in a Collection are organized into one or more groups.
static class	Object_Collection.Object_CollectionOrder	The link between a Object_Tag (which in turn references a Object_Product) and a Object_Collection, including its ordering within the Collection.
static class	Object_Collection.Object_CollectionTrait	A trait descriptor for a Object_Collection.
static class	Object_Collection.Object_CollectionVersion	A version of a Object_Collection.
static class	Object_Collection.Other_CollectionType	The type of a Object_Collection.

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T extends java.lang.Object>, android.os.Parcelable.Creator<T extends java.lang.Object>

Field Summary

Fields

Modifier and Type	Field	Description
static android.os.Parcelable.Creator<Object_Collection>	CREATOR
boolean	isPublic

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor

Description

Object_Collection(long id, long channel_id, long sort_channel_id, java.lang.String name, java.lang.String display_name, java.lang.String description, java.lang.String code, boolean published, java.lang.String start_date, java.lang.String end_date, java.lang.String comment, java.lang.String created_at, java.lang.String updated_at, java.lang.String traits, java.lang.String image, java.lang.String venue, int order, boolean auto_wili, java.lang.String sort_channel_name, java.lang.String badge_method, java.lang.String currency, java.lang.String timezone, boolean display_time, boolean display_price, boolean display_quantity, boolean display_bin, boolean is_blind, boolean display_group_headings, boolean has_predict_order, int product_count, boolean is_pinned, boolean is_browsable, boolean archived)

Method Summary

Modifier and Type	Method	Description
boolean	filter(java.io.Serializable serializable)
java.lang.String	getBadgeMethod()
long	getChannelId()
java.lang.String	getCode()
Object_Collection.Other_CollectionType	getCollectionType()	Collection Type of a specific collection.
java.lang.String	getComment()
java.lang.String	getCreatedAt()
java.lang.String	getCurrency()
java.lang.String	getDescription()
java.lang.String	getEndDate()
Object_Collection.Object_CollectionVersion	getFirstVersion()
java.lang.String	getImage(int width, int height, int quality)	Get the collection's image.
java.lang.String	getName()
int	getProductCount()
long	getSortChannelId()
java.lang.String	getSortChannelName()
java.lang.String	getStartDate()
java.lang.String	getTimezone()
java.util.ArrayList<Object_Collection.Object_CollectionTrait>	getTraits()
java.lang.String	getUpdatedAt()
Object_Venue	getVenue()
java.util.ArrayList<Object_Collection.Object_CollectionVersion>	getVersions()
boolean	hasPredictOrder()
boolean	isArchived()
boolean	isBlind()
boolean	isBrowsable()
boolean	isDisplayBin()
boolean	isDisplayGroupHeadings()
boolean	isDisplayPrice()
boolean	isDisplayQuantity()
boolean	isDisplayTime()
boolean	isEvent()	Lets us know if a collection is of the type Object_Collection.Other_CollectionType.EVENT.
boolean	isInventory()	Lets us know if a collection is of the type Object_Collection.Other_CollectionType.INVENTORY.
boolean	isMyCellar()
boolean	isPublic()
boolean	isPublished()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class classes.Object_BaseObject

describeContents, equals, getId, hashCode, setId

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

isPublic

@SerializedName("public")
public boolean isPublic

CREATOR

public static final android.os.Parcelable.Creator<Object_Collection> CREATOR

Constructor Detail

Object_Collection

public Object_Collection(long id,
                         long channel_id,
                         long sort_channel_id,
                         java.lang.String name,
                         java.lang.String display_name,
                         java.lang.String description,
                         java.lang.String code,
                         boolean published,
                         java.lang.String start_date,
                         java.lang.String end_date,
                         java.lang.String comment,
                         java.lang.String created_at,
                         java.lang.String updated_at,
                         java.lang.String traits,
                         java.lang.String image,
                         java.lang.String venue,
                         int order,
                         boolean auto_wili,
                         java.lang.String sort_channel_name,
                         java.lang.String badge_method,
                         java.lang.String currency,
                         java.lang.String timezone,
                         boolean display_time,
                         boolean display_price,
                         boolean display_quantity,
                         boolean display_bin,
                         boolean is_blind,
                         boolean display_group_headings,
                         boolean has_predict_order,
                         int product_count,
                         boolean is_pinned,
                         boolean is_browsable,
                         boolean archived)

Method Detail

getCollectionType

public Object_Collection.Other_CollectionType getCollectionType()

Collection Type of a specific collection. In general, a Collection will be an Object_Collection.Other_CollectionType.INVENTORY or an Object_Collection.Other_CollectionType.EVENT. Events are temporal in nature, such as a tasting events or weekly promotions. Inventories, whether entire inventories or subsets of an inventory, are meant to change from time to time but are not specifically temporal in nature.

Returns:

Object_Collection.Other_CollectionType

isArchived

public boolean isArchived()

isBrowsable

public boolean isBrowsable()

getProductCount

public int getProductCount()

hasPredictOrder

public boolean hasPredictOrder()

isMyCellar

public boolean isMyCellar()

getTimezone

public java.lang.String getTimezone()

isDisplayPrice

public boolean isDisplayPrice()

isPublic

public boolean isPublic()

isDisplayBin

public boolean isDisplayBin()

getSortChannelName

public java.lang.String getSortChannelName()

isDisplayQuantity

public boolean isDisplayQuantity()

isDisplayTime

public boolean isDisplayTime()

isBlind

public boolean isBlind()

getCurrency

public java.lang.String getCurrency()

getBadgeMethod

public java.lang.String getBadgeMethod()

getSortChannelId

public long getSortChannelId()

getVersions

public java.util.ArrayList<Object_Collection.Object_CollectionVersion> getVersions()

getFirstVersion

public Object_Collection.Object_CollectionVersion getFirstVersion()

getImage

public java.lang.String getImage(int width,
                                 int height,
                                 int quality)

Get the collection's image.

Parameters:

width - returns an image with the specified width in pixels.

height - returns an image with the specified height in pixels.

quality - returns an image with the specified quality. Scales from 0 - 100.

Returns:

the URL of the requested image.

getChannelId

public long getChannelId()

getName

public java.lang.String getName()

getDescription

public java.lang.String getDescription()

getCode

public java.lang.String getCode()

isPublished

public boolean isPublished()

getStartDate

public java.lang.String getStartDate()

getEndDate

public java.lang.String getEndDate()

getComment

public java.lang.String getComment()

getCreatedAt

public java.lang.String getCreatedAt()

getUpdatedAt

public java.lang.String getUpdatedAt()

getTraits

public java.util.ArrayList<Object_Collection.Object_CollectionTrait> getTraits()

getVenue

public Object_Venue getVenue()

filter

public boolean filter(java.io.Serializable serializable)

Overrides:

filter in class Object_BaseObject

isDisplayGroupHeadings

public boolean isDisplayGroupHeadings()

isInventory

public boolean isInventory()

Lets us know if a collection is of the type Object_Collection.Other_CollectionType.INVENTORY.

Returns:

boolean

isEvent

public boolean isEvent()

Lets us know if a collection is of the type Object_Collection.Other_CollectionType.EVENT.

Returns:

boolean

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

Overrides:

writeToParcel in class Object_BaseObject