global static List<String> getCurrencies()

Retrieves a list of currencies in the current user's org.

Return Value

This service returns a list of String objects.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

//Call the method
List<String> currencyNames = ffrr.ViewService.getCurrencies();

//Output the currencies that were retrieved
for (String currencyName : currencyNames)
{
    system.debug('Currency: ' + currencyName);
}

global static List<ffrr.ViewService.Tab> getDefaultTabs()

Retrieves a list of default tabs available to the current user. These are created using the ffrr__Settings__c records.

Return Value

This service returns a list of ffrr.ViewService.Tab objects.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

//Note: This sample demonstrates how to call the getDefaultTabs method and therefore
//relies on there being data within the system. For the sample to run fully
//Recognition Settings, Recognition Templates, Recognition Years and Periods, and Tabs should be available.
//If the data isn't available then the returned results will vary.

//Call the method
List<ffrr.ViewService.Tab> defaultTabs = ffrr.ViewService.getDefaultTabs();

//Output the default tabs that were retrieved
for (ffrr.ViewService.Tab defaultTab : defaultTabs)
{
    system.debug('Tab.isActive: ' + defaultTab.isActive);
    system.debug('Tab.objectType: ' + defaultTab.objectType);
    system.debug('Tab.selectors: ' + defaultTab.selectors);
    system.debug('Tab.tabFilter: ' + defaultTab.tabFilter);
}

global static List<ffrr.ViewService.Tab> getTabs()

Retrieves a list of all of tabs which have been saved by the current user. Will return the working copy. If no working copy exists for the current user then the defaults will be returned.

Return Value

This service returns a list of ffrr.ViewService.Tab objects.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

//Note: This sample demonstrates how to call the getTabs method and therefore
//relies on there being data within the system. For the sample to run fully
//Recognition Settings, Recognition Templates, Recognition Years and Periods, and Tabs should be available.
//If the data isn't available then the returned results will vary.

//Call the method
List<ffrr.ViewService.Tab> allTabs = ffrr.ViewService.getTabs();

//Output the tabs that were retrieved
for (ffrr.ViewService.Tab tabDetails : allTabs)
{
    system.debug('Tab.isActive: ' + tabDetails.isActive);
    system.debug('Tab.objectType: ' + tabDetails.objectType);
    system.debug('Tab.selectors: ' + tabDetails.selectors);
    system.debug('Tab.tabFilter: ' + tabDetails.tabFilter);
}

global static List<ffrr.ViewService.Tab> getTabs(ffrr.ViewService.ViewType viewType)

Retrieves a list of all of tabs of the specified type (Actual, Forecast) which have been saved by the current user.

Input Parameters

Return Value

This service returns a list of ffrr.ViewService.Tab objects.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

//Note: This sample demonstrates how to call the getTabs method and therefore
//relies on there being data within the system. For the sample to run fully
//Recognition Settings, Recognition Templates, Recognition Years and Periods, and Tabs should be available.
//If the data isn't available then the returned results will vary.

//Call the method for the forecast view type
List<ffrr.ViewService.Tab> allTabs = ffrr.ViewService.getTabs(ffrr.ViewService.ViewType.FORECAST);

//Output the tabs that were retrieved
for (ffrr.ViewService.Tab tabDetails : allTabs)
{
    system.debug('Tab.isActive: ' + tabDetails.isActive);
    system.debug('Tab.objectType: ' + tabDetails.objectType);
    system.debug('Tab.selectors: ' + tabDetails.selectors);
    system.debug('Tab.tabFilter: ' + tabDetails.tabFilter);
}

global static List<ffrr.ViewService.Tab> getTabsForView(String viewName)

Retrieves a list of tabs for the specified shared recognition view.

Input Parameters

Return Value

This service returns a list of ffrr.ViewService.Tab objects.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

//Note: This sample demonstrates how to call the getTabsForView method and therefore
//relies on there being data within the system. For the sample to run fully
//Recognition Settings, Recognition Templates, Recognition Years and Periods, Tabs and Views should be
//available. If the data isn't available then the returned results will vary. As
//this sample will retrieve tabs for a specific View, it is necessary that the View
//exists and that its name is used to populate the a String variable named viewName.

//Call the method
String viewName = 'Accounts View';
List<ffrr.ViewService.Tab> viewTabs = ffrr.ViewService.getTabsForView(viewName);

//Output the view tabs that were retrieved
for (ffrr.ViewService.Tab viewTab : viewTabs)
{
    system.debug('Tab.isActive: ' + viewTab.isActive);
    system.debug('Tab.objectType: ' + viewTab.objectType);
    system.debug('Tab.selectors: ' + viewTab.selectors);
    system.debug('Tab.tabFilter: ' + viewTab.tabFilter);
}

global static List<String> getViewNames()

Retrieves the list of recognition view names which are available to all users.

Return Value

This service returns a list of String objects.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

//Note: This sample demonstrates how to call the getViewNames method and therefore
//relies on there being data within the system. For the sample to run fully
//Recognition Settings, Recognition Templates, Recognition Years and Periods, Tabs and Views should be
//available. If the data isn't available then the returned results will vary.

//Call the method
List<String> viewNames = ffrr.ViewService.getViewNames();

//Output the names of the views that were retrieved
for (String viewName: viewNames)
{
    system.debug('ViewName: ' + viewName);
}

global static List<ffrr.ViewService.Tab> getWorkingCopy()

Retrieves the working recognition view for the current user.

Return Value

This service returns a list of ffrr.ViewService.Tab objects.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

//Note: This sample demonstrates how to call the getWorkingCopy method and therefore
//relies on there being data within the system. For the sample to run fully
//Recognition Settings, Recognition Templates, Recognition Years and Periods, and Tabs should be available.
//If the data isn't available then the returned results will vary.

//Call the method
List<ffrr.ViewService.Tab> workingCopyTabs = ffrr.ViewService.getWorkingCopy();

//Output the working copy tabs that were retrieved
for (ffrr.ViewService.Tab workingCopy: workingCopyTabs)
{
    system.debug('Tab.isActive: ' + workingCopy.isActive);
    system.debug('Tab.objectType: ' + workingCopy.objectType);
    system.debug('Tab.selectors: ' + workingCopy.selectors);
    system.debug('Tab.tabFilter: ' + workingCopy.tabFilter);
}

global static List<ffrr.ViewService.Tab> getWorkingCopy(ffrr.ViewService.ViewType viewType)

Retrieves the working recognition view for the current user for the specified type (Actual, Forecast). If the working recognition view does not exist the method retrieves the default tabs.

Input Parameters

Return Value

This service returns a list of ffrr.ViewService.Tab objects.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

//Note: This sample demonstrates how to call the getWorkingCopy method and therefore
//relies on there being data within the system. For the sample to run fully
//Recognition Settings, Recognition Templates, Recognition Years and Periods, and Tabs should be available.
//If the data isn't available then the returned results will vary.

//Call the method for the forecast view type
List<ffrr.ViewService.Tab> workingCopyTabs = ffrr.ViewService.getWorkingCopy(ffrr.ViewService.ViewType.FORECAST);

//Output the working copy tabs that were retrieved
for (ffrr.ViewService.Tab workingCopy: workingCopyTabs)
{
    system.debug('Tab.isActive: ' + workingCopy.isActive);
    system.debug('Tab.objectType: ' + workingCopy.objectType);
    system.debug('Tab.selectors: ' + workingCopy.selectors);
    system.debug('Tab.tabFilter: ' + workingCopy.tabFilter);
}

global static void save(List<ffrr.ViewService.Tab> tabs)

Saves the details of a set of revenue recognition tabs for a user's personal use. This saved data will not be available to other users.

Input Parameters

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

//Make sure that we have a filter in the system for the field StageName on the Opportunity object
ffrr__Filter__c stageFilter = new ffrr__Filter__c();
stageFilter.ffrr__ObjectAPIName__c = 'Opportunity';
stageFilter.ffrr__FieldAPIName__c = 'StageName';
insert stageFilter;

//Create the tab structure to save, along with the tab filter and tab filter selector
ffrr.ViewService.Tab myTab = new ffrr.ViewService.Tab();
ffrr.ViewService.TabFilter tabFilter = new ffrr.ViewService.TabFilter();
ffrr.ViewService.TabSelectorFilter tabSelectorFilter = new ffrr.ViewService.TabSelectorFilter();

//Populate the tab and connect it to the tab filter and the tab filter selector
myTab.isActive = true;
myTab.objectType = Opportunity.SObjectType;
myTab.tabFilter = tabFilter;

//Setup the tab selector and create its filter object (connecting it to the tab selector filter)
ffrr.ViewService.TabSelector tabSelector = new ffrr.ViewService.TabSelector();
tabSelector.objectType = Opportunity.SObjectType;
tabSelector.filters = new List<ffrr.ViewService.TabSelectorFilter>{tabSelectorFilter};

//Connect the tab selector to the tab
List<ffrr.ViewService.TabSelector> tabSelectorList = new List<ffrr.ViewService.TabSelector>();
tabSelectorList.add(tabSelector);
myTab.selectors = tabSelectorList;

//Setup the tab selector filter (filtering where StageName is 'Qualification' or 'Prospecting')
tabSelectorFilter.field = Opportunity.StageName;
tabSelectorFilter.values = new List<Object>{'Qualification', 'Prospecting'};

//Setup the recognition date and filter currency
tabFilter.currencyName = 'USD';
tabFilter.recognitionDate = date.today();

//Call the method to save the tab against the view 'Opportunity' for a forecast view type
ffrr.ViewService.save(new List<ffrr.ViewService.Tab>{myTab}, ffrr.ViewService.ViewType.FORECAST);

global static void save(List<ffrr.ViewService.Tab> tabs, String viewName)

Saves the details of a shared recognition view so that it is available for other users to use.

Input Parameters

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

//Make sure that we have a filter in the system for the field StageName on the Opportunity object
ffrr__Filter__c stageFilter = new ffrr__Filter__c();
stageFilter.ffrr__ObjectAPIName__c = 'Opportunity';
stageFilter.ffrr__FieldAPIName__c = 'StageName';
insert stageFilter;

//Create the tab structure to save, along with the tab filter and tab filter selector
ffrr.ViewService.Tab myTab = new ffrr.ViewService.Tab();
ffrr.ViewService.TabFilter tabFilter = new ffrr.ViewService.TabFilter();
ffrr.ViewService.TabSelectorFilter tabSelectorFilter = new ffrr.ViewService.TabSelectorFilter();

//Populate the tab and connect it to the tab filter and the tab filter selector
myTab.isActive = true;
myTab.objectType = Opportunity.SObjectType;
myTab.tabFilter = tabFilter;

//Setup the tab selector and create its filter object (connecting it to the tab selector filter)
ffrr.ViewService.TabSelector tabSelector = new ffrr.ViewService.TabSelector();
tabSelector.objectType = Opportunity.SObjectType;
tabSelector.filters = new List<ffrr.ViewService.TabSelectorFilter>{tabSelectorFilter};

//Connect the tab selector to the tab
List<ffrr.ViewService.TabSelector> tabSelectorList = new List<ffrr.ViewService.TabSelector>();
tabSelectorList.add(tabSelector);
myTab.selectors = tabSelectorList;

//Setup the tab selector filter (filtering where StageName is 'Qualification' or 'Prospecting')
tabSelectorFilter.field = Opportunity.StageName;
tabSelectorFilter.values = new List<Object>{'Qualification', 'Prospecting'};

//Setup the recognition date and filter currency
tabFilter.currencyName = 'USD';
tabFilter.recognitionDate = date.today();

//Call the method to save the tab against the view 'Opportunity'
ffrr.ViewService.save(new List<ffrr.ViewService.Tab>{myTab}, 'Opportunity');

global static void save(List<ffrr.ViewService.Tab> tabs, ffrr.ViewService.ViewType viewType)

Saves the details of a set of revenue recognition tabs of the specified view type for a user's personal use. This saved data will not be available to other users.

Input Parameters

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

//Make sure that we have a filter in the system for the field StageName on the Opportunity object
ffrr__Filter__c stageFilter = new ffrr__Filter__c();
stageFilter.ffrr__ObjectAPIName__c = 'Opportunity';
stageFilter.ffrr__FieldAPIName__c = 'StageName';
insert stageFilter;

//Create the tab structure to save, along with the tab filter and tab filter selector
ffrr.ViewService.Tab myTab = new ffrr.ViewService.Tab();
ffrr.ViewService.TabFilter tabFilter = new ffrr.ViewService.TabFilter();
ffrr.ViewService.TabSelectorFilter tabSelectorFilter = new ffrr.ViewService.TabSelectorFilter();

//Populate the tab and connect it to the tab filter and the tab filter selector
myTab.isActive = true;
myTab.objectType = Opportunity.SObjectType;
myTab.tabFilter = tabFilter;

//Setup the tab selector and create its filter object (connecting it to the tab selector filter)
ffrr.ViewService.TabSelector tabSelector = new ffrr.ViewService.TabSelector();
tabSelector.objectType = Opportunity.SObjectType;
tabSelector.filters = new List<ffrr.ViewService.TabSelectorFilter>{tabSelectorFilter};

//Connect the tab selector to the tab
List<ffrr.ViewService.TabSelector> tabSelectorList = new List<ffrr.ViewService.TabSelector>();
tabSelectorList.add(tabSelector);
myTab.selectors = tabSelectorList;

//Setup the tab selector filter (filtering where StageName is 'Qualification' or 'Prospecting')
tabSelectorFilter.field = Opportunity.StageName;
tabSelectorFilter.values = new List<Object>{'Qualification', 'Prospecting'};

//Setup the recognition date and filter currency
tabFilter.currencyName = 'USD';
tabFilter.recognitionDate = date.today();

//Call the method to save the tab for a forecast view type
ffrr.ViewService.save(new List<ffrr.ViewService.Tab>{myTab}, 'Opportunity', ffrr.ViewService.ViewType.FORECAST);

global static void save(List<ffrr.ViewService.Tab> tabs, String viewName, ffrr.ViewService.ViewType viewType)

Saves the details of a shared recognition view of the specified view type so that it is available for other users to use.

Input Parameters

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

//Make sure that we have a filter in the system for the field StageName on the Opportunity object
ffrr__Filter__c stageFilter = new ffrr__Filter__c();
stageFilter.ffrr__ObjectAPIName__c = 'Opportunity';
stageFilter.ffrr__FieldAPIName__c = 'StageName';
insert stageFilter;

//Create the tab structure to save, along with the tab filter and tab filter selector
ffrr.ViewService.Tab myTab = new ffrr.ViewService.Tab();
ffrr.ViewService.TabFilter tabFilter = new ffrr.ViewService.TabFilter();
ffrr.ViewService.TabSelectorFilter tabSelectorFilter = new ffrr.ViewService.TabSelectorFilter();

//Populate the tab and connect it to the tab filter and the tab filter selector
myTab.isActive = true;
myTab.objectType = Opportunity.SObjectType;
myTab.tabFilter = tabFilter;

//Setup the tab selector and create its filter object (connecting it to the tab selector filter)
ffrr.ViewService.TabSelector tabSelector = new ffrr.ViewService.TabSelector();
tabSelector.objectType = Opportunity.SObjectType;
tabSelector.filters = new List<ffrr.ViewService.TabSelectorFilter>{tabSelectorFilter};

//Connect the tab selector to the tab
List<ffrr.ViewService.TabSelector> tabSelectorList = new List<ffrr.ViewService.TabSelector>();
tabSelectorList.add(tabSelector);
myTab.selectors = tabSelectorList;

//Setup the tab selector filter (filtering where StageName is 'Qualification' or 'Prospecting')
tabSelectorFilter.field = Opportunity.StageName;
tabSelectorFilter.values = new List<Object>{'Qualification', 'Prospecting'};

//Setup the recognition date and filter currency
tabFilter.currencyName = 'USD';
tabFilter.recognitionDate = date.today();

//Call the method to save the tab against the view 'Opportunity' for a forecast view type
ffrr.ViewService.save(new List<ffrr.ViewService.Tab>{myTab}, 'Opportunity', ffrr.ViewService.ViewType.FORECAST);

global static void save(List<ffrr.ViewService.Tab> tabs, String viewName, ffrr.ViewService.SaveOptions saveOptions)

Saves the details of a shared recognition view of the specified view type so that it is available for other users to use.

Input Parameters

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

//Make sure that we have a filter in the system for the field StageName on the Opportunity object
ffrr__Filter__c stageFilter = new ffrr__Filter__c();
stageFilter.ffrr__ObjectAPIName__c = 'Opportunity';
stageFilter.ffrr__FieldAPIName__c = 'StageName';
insert stageFilter;

//Create the tab structure to save, along with the tab filter and tab filter selector
ffrr.ViewService.Tab myTab = new ffrr.ViewService.Tab();
ffrr.ViewService.TabFilter tabFilter = new ffrr.ViewService.TabFilter();
ffrr.ViewService.TabSelectorFilter tabSelectorFilter = new ffrr.ViewService.TabSelectorFilter();

//Populate the tab and connect it to the tab filter and the tab filter selector
myTab.isActive = true;
myTab.objectType = Opportunity.SObjectType;
myTab.tabFilter = tabFilter;

//Setup the tab selector and create its filter object (connecting it to the tab selector filter)
ffrr.ViewService.TabSelector tabSelector = new ffrr.ViewService.TabSelector();
tabSelector.objectType = Opportunity.SObjectType;
tabSelector.filters = new List<ffrr.ViewService.TabSelectorFilter>{tabSelectorFilter};

//Connect the tab selector to the tab
List<ffrr.ViewService.TabSelector> tabSelectorList = new List<ffrr.ViewService.TabSelector>();
tabSelectorList.add(tabSelector);
myTab.selectors = tabSelectorList;

//Setup the tab selector filter (filtering where StageName is 'Qualification' or 'Prospecting')
tabSelectorFilter.field = Opportunity.StageName;
tabSelectorFilter.values = new List<Object>{'Qualification', 'Prospecting'};

//Setup the recognition date and filter currency
tabFilter.currencyName = 'USD';
tabFilter.recognitionDate = date.today();

// Setup the Options so that a working copy will be saved as well as a global copy.
ffrr.ViewService.SaveOptions saveOptions = new ffrr.ViewService.SaveOptions();
saveOptions.SaveWorkingCopy = true;
saveOptions.ViewType = ffrr.ViewService.ViewType.ACTUAL;

//Call the method to save the tab against the view 'Project__c' for an actual view type
ffrr.ViewService.save(new List<ffrr.ViewService.Tab>{myTab}, 'Opportunity', saveOptions);

global static ffrr.ViewService.SearchResult search(ffrr.ViewService.Tab tab, Schema.SObjectType objectType, String value)

Retrieves items from within the current tab using the selection filters that have been defined previously and the supplied value to search for. The returned data includes both the filters that were applied and the ids and names of the matched items.

Input Parameters

Return Value

This service returns a ffrr.ViewService.SearchResult object.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

//Note: This sample demonstrates how to call the search method for a specific object
//within a specific tab, and therefore relies on there being data within the system.
//For the sample to run Recognition Settings, Recognition Templates and data records should be available. If
//the data isn't available then the results will vary.

//Make sure that we have some filters for Opportunity object (in this case Region, CostCenter and Text)
ffrr__Filter__c regionFilter = new ffrr__Filter__c();
regionFilter.ffrr__ObjectAPIName__c = 'Opportunity';
regionFilter.ffrr__FieldAPIName__c = 'StageName';

ffrr__Filter__c costCenterFilter = new ffrr__Filter__c();
costCenterFilter.ffrr__ObjectAPIName__c = 'Opportunity';
costCenterFilter.ffrr__FieldAPIName__c = 'AccountName';

ffrr__Filter__c textFilter = new ffrr__Filter__c();
textFilter.ffrr__ObjectAPIName__c = 'Opportunity';
textFilter.ffrr__FieldAPIName__c = 'LeadSource';

insert new List<ffrr__Filter__c>{regionFilter, costCenterFilter, textFilter};


//Try to extract all of the tabs in the system for Opportunity
List<ffrr.ViewService.Tab> viewTabList = ffrr.ViewService.getTabsForView('Opportunity');

if (viewTabList.Size() > 0)   //Do we have any tabs?
{                                 //Yes - We'll search in the first one
    ffrr.ViewService.Tab searchTab = viewTabList[0];   //Store which tab we'll be searching in

    //Call the method to search Opportunity where any of the filters (Region__c, CostCenter__c or Text__c) equal 'Prospecting'
    ffrr.ViewService.SearchResult searchResults = ffrr.ViewService.search(searchTab, Opportunity.SObjectType, 'Prospecting');

    //Output the results that were returned
    for (ffrr.ViewService.Reference searchResult: searchResults.records)
    {
        System.debug('SearchResult: ' + searchResult);
    }
}

global static List<Object> search(ffrr.ViewService.Tab tab, Schema.SObjectType objectType, Schema.SObjectField field, String value)

Retrieves items from within the current tab based on the specified field rather than any selection filters that have been previously defined. The returned data includes both the filters that were applied and the ids and names of the matched items.

Input Parameters

Return Value

This service returns a list of Object objects.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

//Note: This sample demonstrates how to call the search method for a specific field
//in a specific object within a specific tab of a specific view type, and therefore relies on there being
//data within the system. For the sample to run Recognition Settings, Recognition Templates and data records
//should be available. If the data isn't available then the results will vary.

//Try to extract all of the tabs in the system for Opportunity
List<ffrr.ViewService.Tab> viewTabList = ffrr.ViewService.getTabsForView('Opportunity');

if (viewTabList.Size() > 0)   //Do we have any tabs?
{                                 //Yes - We'll search in the first one
    ffrr.ViewService.Tab searchTab = viewTabList[0];   //Store which tab we'll be searching in

    //Call the method to search Opportunity where the StageName field equals 'Prospecting'
    List<Object> searchResults = ffrr.ViewService.search(searchTab, Opportunity.SObjectType, Opportunity.StageName, 'Prospecting');
}

global static ffrr.ViewService.SearchResult search(ffrr.ViewService.Tab tab, Schema.SObjectType objectType, String value, ffrr.ViewService.ViewType viewType)

Retrieves items from within the current tab of the specified view type using the selection filters that have been defined previously and the supplied value to search for. The returned data includes both the filters that were applied and the ID's and names of the matched items.

Input Parameters

Return Value

This service returns a ffrr.ViewService.SearchResult object.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

//Note: This sample demonstrates how to call the search method for a specific object
//within a specific tab, and therefore relies on there being data within the system.
//For the sample to run Recognition Settings, Recognition Templates and data records should be available. If
//the data isn't available then the results will vary.

//Make sure that we have some filters for Opportunity object (in this case Region, CostCenter and Text)
ffrr__Filter__c regionFilter = new ffrr__Filter__c();
regionFilter.ffrr__ObjectAPIName__c = 'Opportunity';
regionFilter.ffrr__FieldAPIName__c = 'StageName';

ffrr__Filter__c costCenterFilter = new ffrr__Filter__c();
costCenterFilter.ffrr__ObjectAPIName__c = 'Opportunity';
costCenterFilter.ffrr__FieldAPIName__c = 'AccountName';

ffrr__Filter__c textFilter = new ffrr__Filter__c();
textFilter.ffrr__ObjectAPIName__c = 'Opportunity';
textFilter.ffrr__FieldAPIName__c = 'LeadSource';

insert new List<ffrr__Filter__c>{regionFilter, costCenterFilter, textFilter};


//Try to extract all of the tabs in the system for Opportunity
List<ffrr.ViewService.Tab> viewTabList = ffrr.ViewService.getTabsForView('Opportunity');

if (viewTabList.Size() > 0)   //Do we have any tabs?
{                                 //Yes - We'll search in the first one
    ffrr.ViewService.Tab searchTab = viewTabList[0];   //Store which tab we'll be searching in

    //Call the method to search Opportunity where any of the filters (Region__c, CostCenter__c or Text__c) equal 'Prospecting'
    ffrr.ViewService.SearchResult searchResults = ffrr.ViewService.search(searchTab, Opportunity.SObjectType, 'Prospecting', ffrr.ViewService.ViewType.FORECAST);

    //Output the results that were returned
    for (ffrr.ViewService.Reference searchResult: searchResults.records)
    {
        System.debug('SearchResult: ' + searchResult);
    }
}

global static List<Object> search(ffrr.ViewService.Tab tab, Schema.SObjectType objectType, Schema.SObjectField field, String value, ffrr.ViewService.ViewType viewType)

Retrieves items from within the current tab of the specified type of view based on the specified field rather than any selection filters that have been previously defined. The returned data includes both the filters that were applied and the ID's and names of the matched items.

Input Parameters

Return Value

This service returns a list of Object objects.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

//Note: This sample demonstrates how to call the search method for a specific field
//in a specific object within a specific tab of a specific view type, and therefore relies on there being
//data within the system. For the sample to run Recognition Settings, Recognition Templates and data records
//should be available. If the data isn't available then the results will vary.

//Try to extract all of the tabs in the system for Opportunity
List<ffrr.ViewService.Tab> viewTabList = ffrr.ViewService.getTabsForView('Opportunity');

if (viewTabList.Size() > 0)   //Do we have any tabs?
{                                 //Yes - We'll search in the first one
    ffrr.ViewService.Tab searchTab = viewTabList[0];   //Store which tab we'll be searching in

    //Call the method to search Opportunity where the Region__c field equals 'UK' in the view of type Forecast
    List<Object> searchResults = ffrr.ViewService.search(searchTab, Opportunity.SObjectType, Opportunity.StageName, 'Prospecting', ffrr.ViewService.ViewType.FORECAST);
}

global FieldIdentifier()

global FieldIdentifier(String objectName, String objectLabel, String fieldName, String fieldLabel)

global Tab()

global TabFilter()

Contains the mandatory filters to apply to the tab. These are applied in addition to the user-defined filters defined elsewhere.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

//Note: in order for the following code to work one or more Recognition Years
//should exist in the database.

//Create a list of ids and add the yearr ids retrieved from the database.
List<ID> yearids = new List<ID>();
yearIDs.add('a1ga00000111sg1');
yearIDs.add('a1ga00000111sg2');
yearIDs.add('a1ga00000111sg3');

//Create the TabFilter
ffrr.ViewService.TabFilter tfSample = new ffrr.ViewService.TabFilter();

//Specify the currency that the tab will use
tfSample.currencyName = 'USD';

//Specify the recognition date that the tab will filter by
tfSample.recognitionDate = date.newInstance(2013, 3, 13);

//Specify the years that the tab will filter by
tfSample.years = yearIDs;

global TabSelector()

global TabSelectorFilter()

global Reference()

global SearchResult()

global SaveOptions()